https://github.com/cuhhub/swoptimizationaddon
A Stormworks: Build and Rescue addon that optimizes multiplayer by despawning objects.
https://github.com/cuhhub/swoptimizationaddon
addon lua mod optimization stormworks
Last synced: about 1 year ago
JSON representation
A Stormworks: Build and Rescue addon that optimizes multiplayer by despawning objects.
- Host: GitHub
- URL: https://github.com/cuhhub/swoptimizationaddon
- Owner: cuhHub
- License: apache-2.0
- Created: 2024-02-07T23:17:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T07:54:24.000Z (about 2 years ago)
- Last Synced: 2025-01-30T03:25:04.566Z (about 1 year ago)
- Topics: addon, lua, mod, optimization, stormworks
- Language: Lua
- Homepage: https://dsc.gg/cuhhubsw
- Size: 883 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
# ⚙️ | Optimization Addon
## 📚 | Overview
An addon that optimizes Stormworks multiplayer by despawning objects every tick, therefore reducing the amount of things that need to be synchronized between clients in a server.
This addon uses [Aurora Framework](https://github.com/Cuh4/AuroraFramework), a framework I created that tremendously helps with addon development.
This addon was created for this [cool dude.](https://steamcommunity.com/profiles/76561199259162532)
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=3156193703)
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 go wild.
### 🤓 | Advanced
1) Run `git clone "https://github.com/cuhHub/SWOptimizationAddon.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**](https://discord.com/users/1141077132915777616) ([GitHub](https://github.com/Cuh4))