From b302d2b6cac68eb7664b1bf291496ff7614b3efc Mon Sep 17 00:00:00 2001 From: oatmealine Date: Sat, 25 Jan 2020 13:53:42 +0300 Subject: [PATCH] add README.md --- .eslintignore | 1 + README.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 .eslintignore create mode 100644 README.md diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..cf44e14 --- /dev/null +++ b/.eslintignore @@ -0,0 +1 @@ +**/*.js \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..4cd6383 --- /dev/null +++ b/README.md @@ -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) \ No newline at end of file