https://github.com/arocull/stag-toolkit

Toolsuite and docs for Godot game development
https://github.com/arocull/stag-toolkit

gamedev godot plugin rust techart

Last synced: about 1 month ago
JSON representation

Toolsuite and docs for Godot game development

• Host: GitHub
• URL: https://github.com/arocull/stag-toolkit
• Owner: arocull
• License: bsd-3-clause-clear
• Created: 2024-11-10T03:12:21.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-11-10T05:30:35.000Z (about 1 month ago)
• Last Synced: 2024-11-10T06:21:43.992Z (about 1 month ago)
• Topics: gamedev, godot, plugin, rust, techart
• Language: Rust
• Homepage: https://alanocull.com/
• Size: 8.48 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stag Toolkit

All-purpose toolkit for Godot game creation.

Currently equipped for Godot **4.2.2**

*If this tool has helped you, feel free to [send a Kofi](https://ko-fi.com/stagmath) my way, or to anyone listed in the [credits](#credits)*!

## Feature List

- [IslandBuilder](https://alanocull.com/island_builder.html) tool and corresponding Rust backend

- Shader includes and debug shaders

### Included, but Not Maintained

- Island shader variants and textures used in Abyss

- Prototype animation classes

### Used In

- [Abyss](https://stagmath.itch.io/abyss-demo), an action platformer game (in development)

## Documentation

See the [docs](docs/), or see example usage on my [website](https://alanocull.com/).

If making a contribution, please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard (as best you can).

### General Setup

1. Ensure [Rust](https://www.rust-lang.org/) (I'm using Version 1.82.0) and [Godot](https://godotengine.org/download/archive/) (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!

## Credits

- **[godot-rust](https://godot-rust.github.io/)** is used to hook StagToolkit into Godot Engine

- **[Fast Surface Nets](https://github.com/bonsairobo/fast-surface-nets-rs)** for converting Signed Distance Field data to initial triangle meshes

- **[Godot Engine](https://godotengine.org/)** 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.