leca
/
pixelbattle
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme changes

This commit is contained in:
leca 2023-08-01 11:33:08 +03:00
parent e5a760dbdf
commit fea05a3f01
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,4 +2,22 @@
Self-hosted pixel battle written in NodeJS
For now self hosting requires changes in code (in html/logic.js you must change WS configuration to connect)
# Deploying
To deploy this pixelbattle, you need to:
1. Clone this repo:
`git clone https://git.foxarmy.org/leca/pixelbattle`
2. Install node deps:
`npm update`
3. Run:
`npm run prod`
That's it!
# Tips & tricks
1. Server settings are located in `./settings.json`, you need to change serverAddress in order to deploy
2. When catches SIGUSR1, server will save a board with name read from settings file. SIGINT (CTRL + C) does the same but exit server when board is saved