https://github.com/cuhhub/swhungeraddon
A quality-of-life Stormworks: Build and Rescue addon that adds a hunger system.
https://github.com/cuhhub/swhungeraddon
addon lua mod quality-of-life stormworks
Last synced: 7 months ago
JSON representation
A quality-of-life Stormworks: Build and Rescue addon that adds a hunger system.
- Host: GitHub
- URL: https://github.com/cuhhub/swhungeraddon
- Owner: cuhHub
- License: apache-2.0
- Created: 2024-02-09T07:28:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-09T02:02:22.000Z (about 1 year ago)
- Last Synced: 2025-01-30T03:25:04.538Z (8 months ago)
- Topics: addon, lua, mod, quality-of-life, stormworks
- Language: Lua
- Homepage: https://dsc.gg/cuhhubsw
- Size: 1.74 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
# 🐟 | Hunger Addon
## 📚 | Overview
This addon that adds a hunger system to Stormworks: Build and Rescue, making fishing more of a necessity than a desire.
This addon uses [Aurora Framework](https://github.com/Cuh4/AuroraFramework), a framework I created that tremendously helps with addon development.
Feel free to `git clone`, or even contribute.
## ❓ | Requirements
- **Python 3.12.1+**
- **Stormworks: Build and Rescue** (game)
## 💻 | Setup
### 😎 | Simple
1) [Subscribe to the addon from the Steam workshop.](https://steamcommunity.com/sharedfiles/filedetails/?id=3156992745)
2) Create a new save, but before loading it, enable this addon.
3) When enabling the addon, you will see a cog icon. Click it to open up the options menu, then configure the addon to however you desire. The default options are recommended.
4) Load into the save and have fun.
### 🤓 | Advanced
1) Run `git clone "https://github.com/cuhHub/SWHungerAddon.git"`
2) Optionally, change the addon name in `playlist.xml` to whatever you desire.
3) Run `py combiner.py` to merge all of the code into a `script.lua` file. Feel free to stop it with `CTRL + C` once it has been created.
4) Run `sync.bat`. This will effectively clone the addon into `%appdata%/Stormworks/data/missions`, allowing you to use this addon in-game regardless of what directory the addon is in.
5) Create a save with the addon enabled, and have fun with the addon.
## ✨ | Credit
- **Cuh4** ([GitHub](https://github.com/Cuh4))