diff --git a/README.md b/README.md index cc64b7732..20dc97c27 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,21 @@ Since then I've gained a lot of skills both in Minecraft map development and in 1. Install [`Node.js >= 16.10`](https://nodejs.org/en/download) -1. Install [`Yarn 3.6.3`](https://v3.yarnpkg.com/getting-started/install) by running `corepack enable` -1. Initialize the repo by running `yarn` -1. Enable Yarn's Plug'n'Play with VSCode by running `yarn dlx @yarnpkg/sdks vscode` +2. Install [`Yarn 3.6.3`](https://v3.yarnpkg.com/getting-started/install) by running `corepack enable` +3. Initialize the repo by running `yarn` +4. Enable Yarn's Plug'n'Play with VSCode by running `yarn dlx @yarnpkg/sdks vscode` + +#### Recommended Tools + + + +Install the following apps: + +1. [Blockbench](https://www.blockbench.net/downloads) -- for 3D modelling + 1. In Blockbench, go to `File > Plugins` and install `Animated Java` + 2. Tip: use [blockcolors.app](https://blockcolors.app/) to get a representative vanilla block texture for a desired color +2. [paint.net](https://www.getpaint.net/download.html) -- for image editing +3. [DaVinci Resolve](https://www.blackmagicdesign.com/event/davinciresolvedownload) -- for video editing / frame-by-frame video analysis (of the original fight in Undertale) #### Testing @@ -30,3 +42,21 @@ Since then I've gained a lot of skills both in Minecraft map development and in 5. Run the new profile in your Minecraft launcher to launch a (lightly) modded instance that's able to run `packtest`'s new commands designed for testing 1. Try: `test runall` 2. See `packtest`'s [README](https://github.com/misode/packtest) for full command documentation + +--- + +### Adding a new model/animation + +1. Create a new Animated Java Rig via `File > New > Animated Java Rig` +2. Enter inputs for the following required fields: + 1. `Project Name` + 2. `Resource Pack`: select the `pack.mcmeta` file located in the repository at `resourcepack/pack.mcmeta` + 3. `Data Pack`: select the `pack.mcmeta` file located in the repository at `datapacks/omega-flowey/pack.mcmeta` +3. Export your model/animations by clicking `Animated Java > Export Project` at the top + +When finished, ensure you partition commits into the following categories: + +1. `.ajmodel` + custom texture files ([example](https://github.com/TheAfroOfDoom/omega-flowey-minecraft-remastered/pull/55/commits/344c6da2d0676d2a6d358d5bf30df2e419458b77)) +2. automated export files when clicking `Animated Java > Export Project` ([example](https://github.com/TheAfroOfDoom/https://github.com/TheAfroOfDoom/omega-flowey-minecraft-remastered/pull/55/commits/ee471449e7e131b6c38129ddffb492769bf8064d)) + +This ensures we split commits by what's 100% required (new custom textures + the `.ajmodel` files) and by what's automatically generated (`Export Project` files).