https://github.com/cuhhub/npc-system
NPCs that can talk to you. Built for Stormworks: Build and Rescue.
https://github.com/cuhhub/npc-system
addon lua mod npcsystem stormworks
Last synced: 10 months ago
JSON representation
NPCs that can talk to you. Built for Stormworks: Build and Rescue.
- Host: GitHub
- URL: https://github.com/cuhhub/npc-system
- Owner: cuhHub
- Created: 2024-01-04T19:13:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T04:59:42.000Z (about 2 years ago)
- Last Synced: 2025-03-25T00:46:46.213Z (over 1 year ago)
- Topics: addon, lua, mod, npcsystem, stormworks
- Language: Lua
- Homepage: https://discord.gg/zTQxaZjwDr
- Size: 356 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# NPC System
## 📚 Overview
This repo contains a library that allows you to create NPCs that you can interact with. Built for Stormworks: Build and Rescue.
Utilizes [Aurora Framework by Cuh4](https://github.com/Cuh4/AuroraFramework).
## 😔 Limitations
- NPCs are not persistent. If you create a NPC, and then reload the addon, the NPC will have to be created again
- To start a conversation with a NPC, you can only say one thing. After that, you can say multiple things to progress through the conversation depending on the NPC's dialog.
- Dialogs cannot be natively linked to one another. Each dialog has their own route.
## ❓ Requirements
- **Python 3.11+**
- **Stormworks: Build and Rescue** (game)
## 💻 Setup
1) Run `git clone "https://github.com/cuhHub/NPC-System.git"`
2) Create a `playlist.xml` file containing the content below.
```xml
```
3) Run `py combiner.py` (or run `combiner.bat`) to create a `script.lua` file. Feel free to close it once it has been created.
4) Run `sync.bat` to automatically replicate the addon into your Stormworks' addons folder.
5) Create a save with the addon enabled.
## ✨ Credit
- [**Cuh4**](https://discord.com/users/1141077132915777616) ([GitHub](https://github.com/Cuh4))