Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add recommended tools and new model steps to README #57

Merged
merged 3 commits into from
Jan 4, 2024
Merged

add recommended tools and new model steps to README #57

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a17878
update list numbers to increase
TheAfroOfDoom Jan 3, 2024
719a777
add recommended tools and steps for adding a new model/animation to R…
TheAfroOfDoom Jan 3, 2024
2969b8e
run prettier
TheAfroOfDoom Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,21 @@ Since then I've gained a lot of skills both in Minecraft map development and in
<!-- TODO upgrade to yarn 4? -->

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

<!-- TODO(8): update this README with installation steps for the custom plugins when they are done -->

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

Expand All @@ -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).