Tool | Description |
---|---|
Loading Editor | Add images, descriptions, and icons to loading screens. |
SoundEvent Editor | Edit in-game sounds easily. |
Hotkey Editor | Customize, edit, and manage new keyboard shortcuts. |
AssetGroup Maker | Edit multiple files at once, ideal for large modular sets. |
SmartProp Editor | Simplifies creating smart props. |
The application is organized into modules, with each editor implemented as a separate module. Editors can be run independently if you provide the paths to CS2 and the addon. All editors are integrated through the main application (src/main.py), which manages their settings. If you wish to use an editor separately from the main application, you must create separate settings and handle the CS2 and addon paths manually.
Project folder overview:
src/
: Contains the main application code and all editor modules.forms/
: Minor Qt dialogs, such as About or Launch Options.external/
: External libraries and resources not related to Python (e.g., .NET libraries).dotnet/
: .NET handle, functions (located insrc/external
).
Each major feature or editor has its own folder:
common/
: Shared helpers and logic used across editors.main.py
: General functions, entry point.
Run configurations are available for PyCharm and Visual Studio Code.
-
Run: To run the application, you need to run the main.py file in the src folder. Do not forget to set the working directory to the
hammer5tools
folder, which is in the same root folder as src. Otherwise, just use the ready-made run configurations in your IDE. -
Build:
python makefile.py --build-all --archive
The script will generate exe file in the
hammer5tools
folder. After that it will create a zip archive of the application in thedist
folder for distribution. The archive used by automic updates and can be used to run the application on other computers without installation. -
Installer:
To create the installer, you need to install Inno Setup. Do not change the default installation path.