https://github.com/cuh4/pythontosw
A Python package that allows you to create Stormworks addons without needing to use Lua.
https://github.com/cuh4/pythontosw
addon http lua mod python stormworks
Last synced: 6 months ago
JSON representation
A Python package that allows you to create Stormworks addons without needing to use Lua.
- Host: GitHub
- URL: https://github.com/cuh4/pythontosw
- Owner: Cuh4
- License: apache-2.0
- Created: 2024-05-13T02:33:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-30T15:33:44.000Z (over 1 year ago)
- Last Synced: 2025-03-27T07:21:34.947Z (11 months ago)
- Topics: addon, http, lua, mod, python, stormworks
- Language: Lua
- Homepage: https://dsc.gg/cuhhubsw
- Size: 372 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚙️ | PythonToSW
## 📚 | Overview
A Python package that allows you to create basic addons in Stormworks: Build and Rescue with Python.
```python
import time
import PythonToSW as PTS
addon = PTS.Addon(addonName = "My Python Addon", port = 7800)
def main():
# Every 5 seconds, send a message to everyone
while True:
time.sleep(5)
addon.execute(
PTS.Announce("Server", "Hello World", -1)
)
addon.start(target = main) # Start the addon. This automatically creates an addon and places it in your Stormworks' addon directory, so you can easily use the addon in a save
```
## ⚙️ | Installing this package
- Use `pip install PythonToSW --upgrade`
- Import the package with `import PythonToSW as PTS` in your code
## 😔 | Quirks
- Noticeable delays. This project works through HTTP instead of converting Python code to Lua code, and HTTP is unfortunately slow.
- For your addon to function, the host of the server must run the Python script behind your addon. Closing the Python script will essentially stop the addon.
- No support for `property.slider` and `property.checkbox` as of now.
## ✨ | Credit
- **Cuh4** ([GitHub](https://github.com/Cuh4))