{"id":22201913,"url":"https://github.com/cuhhub/noir","last_synced_at":"2026-03-10T10:07:26.774Z","repository":{"id":242176362,"uuid":"808887032","full_name":"cuhHub/Noir","owner":"cuhHub","description":"A Stormworks: Build and Rescue addon framework that helps you with creating addons as well as keeping addon structure neat.","archived":false,"fork":false,"pushed_at":"2026-03-03T19:42:20.000Z","size":111098,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-03T21:06:06.772Z","etag":null,"topics":["addon","framework","lua","stormworks"],"latest_commit_sha":null,"homepage":"https://cuhhub.gitbook.io/noir","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cuhHub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"patreon":"cuhhubsw"}},"created_at":"2024-06-01T04:30:13.000Z","updated_at":"2025-08-25T17:20:02.000Z","dependencies_parsed_at":"2024-06-01T05:38:57.073Z","dependency_job_id":null,"html_url":"https://github.com/cuhHub/Noir","commit_stats":null,"previous_names":["cuh4/noir"],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/cuhHub/Noir","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuhHub%2FNoir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuhHub%2FNoir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuhHub%2FNoir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuhHub%2FNoir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cuhHub","download_url":"https://codeload.github.com/cuhHub/Noir/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuhHub%2FNoir/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30329698,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addon","framework","lua","stormworks"],"created_at":"2024-12-02T16:11:41.573Z","updated_at":"2026-03-10T10:07:26.737Z","avatar_url":"https://github.com/cuhHub.png","language":"Lua","funding_links":["https://patreon.com/cuhhubsw"],"categories":[],"sub_categories":[],"readme":"![Banner](imgs/banner.png)\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Stormworks-Build%20and%20Rescue-blue?style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/lua-%232C2D72.svg?style=for-the-badge\u0026logo=lua\u0026logoColor=white\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Addon%20Framework-9e6244?style=for-the-badge\"\u003e\n\u003c/div\u003e\n\n## 📚 Overview\nNoir 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.\n\nHelpful examples can be found in [`/examples`](/examples).\n\n## 🍗 Code Snippet\nThe 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.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"imgs/snippet.png\" width=700px\u003e\n\u003c/div\u003e\n\n## 📜 Documentation\nDocumentation can be found [here](https://cuhhub.gitbook.io/noir/).\n\n## 🔨 Installation\nFor learning how to install and use Noir in your addon, please check out the [documentation.](https://cuhhub.gitbook.io/noir/)\n\n## 🤝 Contributing\nIf 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.\n\n## ⚙️ Building Noir\nTo build Noir (tool executables and the bundled Noir `.lua` file), see below.\n\n### Prerequisites\n- Ensure Python 3.13+ is installed (may work on earlier 3.x versions, only tested with 3.13).\n- Ensure your working directory is the folder containing this README (root).\n\n### Steps\n1) 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).\n2) 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.\n3) Run `pip install -r requirements.txt` to install necessary Python packages.\n4) 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.\n\n### Warnings\n- ⚠️ | If `py` in the commands above doesn't work, try `python` or `python3` instead.\n- ⚠️ | `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.\n\n## ✨ Credit\n- [Cuh4](https://github.com/Cuh4)\n- [Avril112113](https://github.com/Avril112113)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuhhub%2Fnoir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcuhhub%2Fnoir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuhhub%2Fnoir/lists"}