Stag Toolkit

All-purpose toolkit for Godot game creation.

Currently equipped for Godot 4.3+

Warning

This addon is highly experimental and frequently subject to change based on personal needs. These updates will sometimes require usage to be updated accordingly. Use at your own risk!

If this tool has helped you, feel free to send a Kofi my way, or to anyone listed in the credits!

Feature List

• StagTest framework for simulating gameplay and performing benchmarks
• IslandBuilder tool and corresponding Rust backend (Rust required)
• QueueFloat class for handling and analyzing large sets of numbers (Rust required)
• Texture/Material importer for .ironpress files
• "Simple LOD" importer for meshes/scenes with custom LODs
• Shader includes and debug shaders

Some features can be toggled on/off via the Project Settings under addons/stag_toolkit. May require an plugin reload or editor restart.

In Repository, but Not Maintained

• Island shader variants and textures used in Abyss
• Prototype animation classes

Used In

• Abyss, an action platformer game (in development)

Documentation

For the most up-to-date API documentation, use Godot's internal "Search Help" feature (hotkey F1).

You can read manually-updated docs online too, or see example usage on my website.

General Setup

1. Ensure Rust (I just use stable) and Godot (using version as specified above) are installed
2. Clone this repository
3. cd into this repository and run cargo fetch

Windows

1. Run $ build.cmd to build the addon
2. Open the addon project (in godot/ subdirectory) inside Godot to verify that it works
3. Copy the godot/addons/stag_toolkit/ directory into your project as addons/stag_toolkit/
4. Done!

Linux

1. $ make all to build the addon
2. Open the addon project in Godot to verify that it works: cd godot/ && godot project.godot
3. Copy the godot/addons/stag_toolkit/ directory into your project as addons/stag_toolkit/
4. Done!

Cross Compiling

Make use Rust's target system!

• Install for key x86_64 platforms: $ rustup target add x86_64-unknown-linux-gnu x86_64-pc-windows-gnu
• Get a list of all platforms: $ rustup target list
• Ensure you have the proper linker installed to make use of cargo

Platforms still working on support for: x86_64-apple-darwin

On Linux

Install the proper linkers!

• Ubuntu: $ sudo apt-get install mingw-w64
• Fedora: $ sudo dnf install mingw64-gcc

Contribution

If making a contribution, please follow the Conventional Commits standard (as best you can).

You may need to install additional toolchains for pre-commit hooks.

• $ pip install pre-commit gdtoolkit - Installs pre-commit hooks and a linting/formatting toolchain for GDScript.
• $ pre-commit install - Initialize pre-commit hooks.

Credits

• godot-rust is used to hook StagToolkit into Godot Engine
• Fast Surface Nets for converting Signed Distance Field data to initial triangle meshes
• Godot Engine where the plugin resides

Disclaimer

This is a mirror of my own private repository.

Issues and feature proposals are tracked there and might not be described here until implementation.