The Script Runner provides an interface within HyperX to load and execute Python Scripts without having to close the software. Scripts executed in this manner use the same API functions as a Script executed outside of HyperX but have the added advantage of being able to automatically work on the loaded Project and have changes immediately reflected in the interface without having to restart. This tool may also serve as a convenient way to organize and access frequently-used utilities. The following steps describe how to use the Script Runner.
The machine executing Scripts must have Python installed, as well as (depending on the script in question) the Python.NET package. More information can be found here.
If Python is installed in another way, the path to the Python installation's main DLL may be automatically detected, but if it is not then it must be provided to the Script Runner. This DLL is located in the installation directory; the exact path and file name will vary depending on the Python version but may be similar to C:\Users\my.username\AppData\Local\Programs\Python\Python311\python311.dll
Finally, a directory from which to load Scripts should be specified. The default location is typically similar to C:\HyperX\Scripts but can be any location that HyperX has access to.
Tip
Several Sample Scripts are provided with the HyperX install and they are all enabled for use with the Script Runner. You can use these as a reference when writing your own Scripts.
Add Script(s) via Package Manager
After a Script Package is installed via the Package Manager, it will be visible in the Script Runner. The Script Runner displays version numbers and provides links to the Script change logs and readmes. The Script Runner also organizes Scripts into folders based on their script.folder Package configuration property.
After installing or re-installing a Package with Scripts, open or refresh the Script Runner to see them.
Once Scripts are loaded into the Script directory, they can be run either through the Script Runner form or through the Ribbon button. Output will be provided in a console window, and any errors will be presented to the user in a pop-up message box.
As of version 2026.1.13, the Script Runner can be run without an open Database/Project open. This is ideal for Projects with especially large models that would normally take a long time to load into the Viewport. To do so:
-
Open HyperX without opening a Database or Project. I.e. Close the initial window that prompts you to open a Project.
-
Navigate to the Run tab of the Ribbon and click the button to open the Script Runner. Notice there are now inputs for a Database and Project. Once you select a Database and Project, you can use the Script Runner as you normally would.