add README.md

This commit is contained in:
oatmealine 2020-01-25 13:53:42 +03:00
parent e0f9b3dfeb
commit b302d2b6ca
No known key found for this signature in database
GPG Key ID: C4CB49CFAD721145
2 changed files with 18 additions and 0 deletions

1
.eslintignore Normal file
View File

@ -0,0 +1 @@
**/*.js

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# cumstorm
a (WIP) geometry dash private server in typescript
its still only about **3%** complete
heavily based on https://github.com/Cvolton/GMDprivateServer/ and https://github.com/matcool/pygdps/ (thanks mat!)
## how-to setup
1. `npm install` OR `yarn install`
2. make a config/config.json file based on the config.example.json file (optional)
3. `tsc && npm start` OR `npm run quickrun`
4. edit the GeometryDash exe to use your url instead of http://boomlings.com (this repo will not provide help for this)