Skip to content
Snippets Groups Projects
Commit 664ee132 authored by Jonas Zohren's avatar Jonas Zohren
Browse files

Add basic Readme

parent 5abe24f5
No related branches found
No related tags found
No related merge requests found
Pipeline #19229 passed
# WorkAdventure Dialogs Game State Server
Simple API-Server to save the state of quests in workadventure
# How it works
- `HTTP GET /game/state/<someID>` to load gameState as json from the server
- `HTTP POST /game/state/<someID>` to save gameState as json on server
- Server stores each gameState in a json file. The filename is the sha265-hash of <someID> passed in the url.
- Global ratelimit by IP, Header `X-Forwarded-For` is trusted.
# Config
This project uses [dotent](https://github.com/motdotla/dotenv#readme) so you can have a `.env` file or pass config to it via environment variables.
The variables and their defaults are listed in [`src/config.ts`](./src/config.ts)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment