https://github.com/cuhhub/noir
A Stormworks: Build and Rescue addon framework that helps you with creating addons as well as keeping addon structure neat.
https://github.com/cuhhub/noir
addon framework lua stormworks
Last synced: 19 days ago
JSON representation
A Stormworks: Build and Rescue addon framework that helps you with creating addons as well as keeping addon structure neat.
- Host: GitHub
- URL: https://github.com/cuhhub/noir
- Owner: cuhHub
- License: apache-2.0
- Created: 2024-06-01T04:30:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-03T19:42:20.000Z (26 days ago)
- Last Synced: 2026-03-03T21:06:06.772Z (26 days ago)
- Topics: addon, framework, lua, stormworks
- Language: Lua
- Homepage: https://cuhhub.gitbook.io/noir
- Size: 106 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## 📚 Overview
Noir is a framework for Stormworks: Build and Rescue designed to (metaphorically!) hold your hand in some areas with addon development, while also giving you a neat way of organizing your addon.
Helpful examples can be found in [`/examples`](/examples).
## 🍗 Code Snippet
The below snippet showcases Noir's events system as well as the OOP nature of the framework. The code below simply sends a notification to any player who joins and gives them an item.
## 📜 Documentation
Documentation can be found [here](https://cuhhub.gitbook.io/noir/).
## 🔨 Installation
For learning how to install and use Noir in your addon, please check out the [documentation.](https://cuhhub.gitbook.io/noir/)
## 🤝 Contributing
If you would like to contribute to Noir, whether that is by creating an issue or by creating a PR, please review [this page in the Noir documentation](https://cuhhub.gitbook.io/noir/contributing) first.
## ⚙️ Building Noir
To build Noir (tool executables and the bundled Noir `.lua` file), see below.
### Prerequisites
- Ensure Python 3.13+ is installed (may work on earlier 3.x versions, only tested with 3.13).
- Ensure your working directory is the folder containing this README (root).
### Steps
1) Create a virtual environment (venv) by running `py -m venv venv` (you may need to use `pip install venv` if the command doesn't work).
2) Activate the venv using `venv\scripts\activate.bat` (Linux/MacOS: `source venv/bin/activate`). Use `deactivate` instead of `activate` to exit the venv at any time.
3) Run `pip install -r requirements.txt` to install necessary Python packages.
4) With the venv activated and necessary packages installed, simply run `build.bat`. This will bundle Noir into one `.lua` file and build all tools in `/tools` into executables by running `py main.py`. The API reference will also get updated (`py build-api-reference.py`). All of the files are then placed into `_build` while the API reference docs will simply be updated in the `docs` folder.
### Warnings
- ⚠️ | If `py` in the commands above doesn't work, try `python` or `python3` instead.
- ⚠️ | `build.bat` is Windows only. You may need to create your own file that does the same and is compatible with your OS if you're not on Windows.
## ✨ Credit
- [Cuh4](https://github.com/Cuh4)
- [Avril112113](https://github.com/Avril112113)