/omega-flowey-minecraft-remastered

Primary LanguagemcfunctionMIT LicenseMIT

Omega Flowey in Minecraft - Remastered

Back in early 2016 I released Omega Flowey in Minecraft.

Since then I've gained a lot of skills both in Minecraft map development and in programming generally. This repo will store any and everything relating to development of a remaster of the original map for modern Minecraft version(s) with better gameplay, performance, and visuals.

Contributing

Setup

Workspace

  1. Install Node.js >= 16.10
  2. Install Yarn 3.6.3 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 -- for 3D modelling
    1. In Blockbench, go to File > Plugins and install Animated Java
    2. Tip: use blockcolors.app to get a representative vanilla block texture for a desired color
  2. paint.net -- for image editing
  3. DaVinci Resolve -- for video editing / frame-by-frame video analysis (of the original fight in Undertale)

Testing

  1. Download the Fabric mod loader and install a new profile to your Minecraft launcher
  2. Download the Fabric API jar
  3. Download the latest release jar of packtest
    1. You should probably download the same version that we're currently specifying in ./.github/workflows/validate.yml
  4. Move the Fabric API and packtest jars into your mods folder in the Minecraft directory (typically %appdata%/.minecraft/mods)
  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 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)
  2. automated export files when clicking Animated Java > Export Project (example)

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).