Node.js: For running code (v16)Yarn: Installing packages and running scripts (npm install -g yarn)MongoDB: For Persistent data (Atlas)Redis: For Leaderboards (Redis Cloud)RediSearch: For AutocompleteHypixel API Key: For requesting Hypixel data, Run/api newon hypixel.net
- Currently we supply public assets for development as a git submodule
- In addition, you must provide a 1.8.9 texture pack in the
assets/public/minecraft-textures/default
- The codebase is split into apps and packages
- Set up a
config.jsfile in the root of the project following theconfig.schema.jsfile (copy paste it over and fill it in) - Pull the git submodules (
git submodule update --init) - Set up the assets by running
cd assets/public && yarn - Use
yarn buildto build all packages and apps, - Use
yarn build:watchto watch files and build them while you code - Use
yarn {appName} startto run an app, egyarn api startto run the API
# Change things in a package/app
$ yarn workspace {app or package name} {command}
# Example: Adding a dependency
$ yarn workspace {app or package name} add {dependency}
# Linting
$ yarn lint
# Testing
$ yarn test
# Type Testing
$ yarn test:types- Follow the guidelines in
.github/CONTRIBUTING.md - If you are unsure of anything join our
Discordand then message,jacob#5432
- If you require support join our
Discordand create a ticket in the#create-ticketchannel
