Animated-Java / animated-java

A Blockbench plugin that makes complex animation a breeze in Minecraft: Java Edition.
Other
159 stars 26 forks source link

Animated Java

Latest Version Total Downloads (Last 4 years) Discord Static Badge

A Blockbench plugin that makes complex animation a breeze in Minecraft: Java Edition.

What is Animated Java?

Animated Java is a plugin for Blockbench that allows you to create custom animations and models for Vanilla Minecraft. It uses the power of Java Edition's Data Pack and Resource Pack systems to bring your creations to life!

Features

And much more!

How to Install

Follow our guide here for detailed instructions on how to install the latest release of Animated Java.

Getting Started

Check out the Getting Started page of our documentation to learn how to use Animated Java.

Contributing to Animated Java

We welcome contributions to Animated Java! If you're interested in contributing, please make sure to run your ideas by us in our Discord server before starting work on them. So that we can ensure that your contributions align with the goals of the project.

Prerequisites

Things you'll need installed before you can setup the development environment

Setting up the Development Environment

  1. Clone the repository.
  2. Run yarn install to install dependencies.
  3. Open up types/blockbench-types.d.ts and replace the content of the file with the following:
    /// <reference types="blockbench-types"/>
  4. Run yarn dev to start the development environment, which will watch for changes and recompile the plugin.
  5. Open Blockbench, then go to File > Plugins > Load Plugin From File and select the animated_java.js file from your local repo (dist/pluginPackage/animated-java.js).
  6. That's it! You're ready to start developing.

[!NOTE] Note that whenever you make changes, you must reload Blockbench as a whole for the changes to function as expected.
You can use Ctrl + Shift + R to reload Blockbench.

Adding Localizations

  1. Follow the steps above to set up the development environment.
  2. Duplicate src/lang/en.yml and rename it to match the language you're translating to. (e.g. fr.yml for French)
  3. Start Translating! Make sure to check your changes in Blockbench to ensure they display correctly.
  4. Once you're done translating, open a pull request with your changes.