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 20.5.1 then nvm use 20.5.1 once the installation completes.
- Install any recommended project extensions.
- 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. - Run
npm run startto start Minecraft. - Work on the project.
The versions used are tracked in the mc-package.json file. To update:
- Change the versions in the mc-package.json file.
- Update the settings.bat file.
- Update the settings.sh file.
These are additional scripts that are provided for easing development processes.
npm run generatestarts a prompt to generate certain project files.npm run symlinkgenerates symlinks between the repo and a minecraft instance.
To create a new release:
- Increment the version in the mc-package.json file.
- Run
npm run releaseto generate a client and server zip file in the .releases directory`.
Files in the repo can be ignored from releases by adding to the respective releaseignore file:
- For client-only ignore entries: .releaseignore-client
- For server-only ignore entries: .releaseignore-server
- A common use case for this is to ignore client-only mods.
- For ignore entries that apply to both client and server releases: .releaseignore-shared