- TypeScript 99.2%
- JavaScript 0.6%
- Dockerfile 0.2%
| .github/workflows | ||
| .vscode | ||
| assets | ||
| src | ||
| test | ||
| .eslintrc.json | ||
| .gitignore | ||
| changes.md | ||
| docker-compose.yml | ||
| Dockerfile | ||
| eslint.config.mjs | ||
| info.md | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| vitest.config.ts | ||
A game-agnostic mod hosting platform.
Running the Server
Running the server is (mostly) easy to do:
- Clone the Repo.
- Run
npm ito install packages. - Run
npm run build_startto build & start the server.
The default location for anything that needs to presist is a folder called storage. This will includes the database and user uploads. This should be automatically created when the server starts. You can find the config file at storage/config.json.
If you are using the docker image, the storage directory will be located at /app/storage. The port is set to 5001 by default.
Config
See src/shared/Config.ts for more info regarding the config file. This file is created when the server starts if it does not exist. The config file should also update itself if any new options get added. It will backup the old config file and create a new one with the new options.
Optionally, you can use environment variables to set the config. All environment vairables are present in the docker-compose.yml file located at the root of the repo. See the config class above.