Skip to content

A game-agnostic* mod hosting platform.

License

Notifications You must be signed in to change notification settings

Saeraphinx/BadBeatMods

Repository files navigation

BadBeatMods A game-agnostic mod hosting platform.

Running the Server

Running the server is (mostly) easy to do:

  1. Clone the Repo.
  2. Run npm i to install packages.
  3. Run npm run build_start to 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.

About

A game-agnostic* mod hosting platform.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •