The repo utilizes Node.js (and npm) to manage build tools, and other useful dependencies. In addition, the repo includes pre-configured settings and recommended extensions to improve the developer experience, so VSCode is recommended.
When first starting development, make sure you go through these steps to get your development environment set up.
To get started, make sure you have Node.js installed. For easier management of your Node.js version, we recommend installing NVM (Node Version Manager) instead. For Windows you can install from the latest release here and for OSX/Linux follow the steps here.
Once installed, run nvm install 16.16.0 then nvm use 16.16.0 once the installation completes.
- Ensure you are using the correct Node.js version by running
npm run setup:node - If you've pulled in changes, make sure you've updated your dependencies by running
npm install - Work on the project
- When ready to commit, run
npm run lintto check for code styling issues. Note: This will run automatically when you try to commit
These are additional scripts that are provided for easing development processes.
npm run formatattempts to auto-format supported file typesnpm run modlistgenerates amodlist.jsonfile in the root of the project. This provides some basic mod dependency tracking. Note: this will run automatically when you try to commitnpm run symlinkgenerates symlinks between the repo and a minecraft instance.