Skip to content

Commit dbf10fc

Browse files
SnaveSutitSnaveSutit
committed
📜 Improve Readme
1 parent 0e0cf6b commit dbf10fc

File tree

1 file changed

+71
-43
lines changed

1 file changed

+71
-43
lines changed

‎README.md

Lines changed: 71 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,105 @@
1-
<div align="center">
2-
<img src="https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/animated_java_icon.webp"/>
1+
<div style="
2+
display: flex;
3+
justify-content: center;
4+
">
5+
<div style="
6+
display: flex;
7+
align-items: center;
8+
margin-bottom: 2rem;
9+
">
10+
<!-- svelte-ignore a11y-missing-attribute -->
11+
<img src="https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/animated_java_icon.svg" style="
12+
width: 128px;
13+
border-radius: 16px;
14+
box-shadow: 4px 4px 8px -4px black;
15+
"/>
16+
<div style="
17+
display: flex;
18+
flex-direction: column;
19+
justify-content: center;
20+
margin-left: 2rem;
21+
">
22+
<span style="font-size:48px; font-weight:bold;">Animated Java</span>
23+
<div>
24+
<a>
25+
<img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FAnimated-Java%2Fanimated-java%2Fmain%2Fpackage.json&query=display_version&prefix=v&style=flat-square&label=%20&color=%2300aced00" width=128>
26+
</a>
27+
</div>
28+
</div>
29+
</div>
330
</div>
4-
<h1 align="center">
5-
Animated Java
6-
<br>
7-
<a href="https://animated-java.dev/discord">
8-
<img src="https://img.shields.io/discord/785339959518953482?color=5865f2&label=Discord&style=flat" alt="Discord" />
9-
</a>
10-
<a>
11-
<img src="https://img.shields.io/github/package-json/v/animated-java/animated-java" alt="GitHub package.json version" />
12-
</a>
13-
</h1>
1431
<h3 align="center">
1532
A Blockbench plugin that makes complex animation a breeze in Minecraft: Java Edition.
1633
</h3>
17-
<br/>
18-
19-
# How to Install
20-
21-
There are two ways to install Animated Java: through the Official Plugin List, or through a direct link.
22-
The Direct link is the recommended way to install Animated Java, as it will always be up to date with the latest version the moment it's released. While the Official Plugin List is also up to date, it may take a few days for the latest version to be available.
23-
24-
## Through the Official Plugin List
25-
26-
Open the Plugins menu in Blockbench (File > Plugins)
27-
![Plugin Menu](https://raw.githubusercontent.com/Animated-Java/animated-java/experimental/src/assets/plugin_menu.png)
2834

29-
Click on the `Available` tab, Then search for Animated Java in the search bar, and click Install.
30-
![Search](https://raw.githubusercontent.com/Animated-Java/animated-java/experimental/src/assets/search.png)
35+
<div align="center">
36+
<img alt="Total Downloads (Last 4 years)" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fblckbn.ch%2Fapi%2Fstats%2Fplugins%3Fweeks%3D192&query=animated_java&style=flat-square&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAXNSR0IArs4c6QAAA6BJREFUeF7tnFFSGzEMhuXkBB0gkLf0JuQmcBLgJMlNmp6keQtkyHCCxJ3NNJ0MTXclW7Js5ucVWfJ%2B38oQYxMIX64Egmt1FCcIcH4JIAACnAk4l0cHQIAzAefy6AAIcCbgXB4dAAHOBJzLowMgwJmAc3l0AAQ4E3Aujw6AABmB1%2B0u9o24m1w19VI1NdkOPATIXlj1aAhQRypLCAEyXurREKCOVJYQAmS81KMhQB2pLCEEyHipR0OAOlJZQgiQ8VKPhgB1pLKEECDjpR4NAepIZQkhQMZLPRoC1JHKEkKAjJd6NASoI5UlhAAZL%2FVoCFBHKksIATJe6tEQoI5UlhACZLxY0W%2Fb3eKwH71Mp9%2FWQwM0BGw2HzMa7%2B%2Bnk%2BvlUD3r77ufinjdvv8gCvdEtI770XxIQq6ADn4Y7xddzUC0vJ1cPVpD7svvKuAM%2FmmOgxJyBJzDPxX0luAmoFt2ItHDhbejV0KqgEvwT7VjpJfp7dWzRye4COiBP9gJKQL64HtLKC6AAb9XglQAB76nhOICNm%2B75xDoidnu%2FyxHEgES%2BN18IsXH0r8ZFRfQPWiOBK6AFuB3LFwE5EjgCGgFvquAVAlhfPjVt3zF%2Fej76fd8zjLnseycz8utA06TkC5HRDTrBxtXfz7YDfL3hu%2FeAYkSBsFyAmqAX42AhOWIw%2Fi%2FMbXAr0pAKQk1wa9OgLWE2uBXKcBKQo3wqxWgLaFW%2BFUL0JJQM%2FzqBeRKqB1%2BEwJSJbQAvxkBUgmtwG9KAFdCS%2FBVBHB2J7M%2Btn4a3Ld3ZAHf%2BvmyN%2BOsJ3hJ3iUJFvC72tbP16SAz8uRFXwIGFi7uk6gENeWf0ZEB2j%2BAEnIBQEJ0DSHQIAmzYRcEJAATXMIBGjSTMgFAQnQNIdAgCbNhFwQkABNc0gLArqDUgNndTSR1JUr9%2F%2BUKmxF%2FL3hUheZArPRuNyRLUB4sq0AlnIlNC525As43rnqP69ZDknZSjEc5tObm1VO1WwBx53J7ftDoLDImUhrY7V2YFUEdPAEN19aY31hvnF1N7meazyImoBjJ8huv2jMv3gOjXX%2FfNKqAo4SNh%2Bz0fjwFCnOuMfEi1OUFVwTxXWM4ScdRsuhe8yy1I43ZKQT%2Farx6h3wVUFZPRcEWJFl5oUAJiirMAiwIsvMCwFMUFZhEGBFlpkXApigrMIgwIosMy8EMEFZhUGAFVlmXghggrIKgwArssy8EMAEZRUGAVZkmXkhgAnKKuw3fJAlf%2F2mKG8AAAAASUVORK5CYII%3D&label=%20&color=%2300aced00">
37+
<img alt="Discord" src="https://img.shields.io/discord/785339959518953482?style=flat-square&logo=discord&label=%20&color=%2300aced00">
3138

32-
## Through the Direct Link
39+
</div>
3340

34-
Open the Plugins menu in BlockBench (File > Plugins)
41+
# What is Animated Java?
3542

36-
![Plugin Menu](https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/plugin_menu.png)
43+
Animated Java is a plugin for Blockbench that allows you to create custom animations and models
44+
for Vanilla Minecraft. It uses the power of Java Edition's Data Pack and Resource Pack systems
45+
to bring your creations to life!
3746

38-
In the Plugins menu, click on `Load Plugin from URL`
47+
## Features
3948

40-
![Load Plugin from URL](https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/load_plugin_from_url.png)
49+
- Variants: Swap between different textures in-game.
50+
- Highly optimized: Hours of performance tests and optimization tweaks have gone into Animated
51+
Java's Exported Data Pack to make sure it has as little performance impact as possible.
52+
- Custom easing functions for keyframes.
53+
- Limited Molang support. If Blockbench can render it, Animated Java can bake it.
54+
- Text Display previewing and animation support.
55+
- Resource Pack-less exporting. Animate Vanilla block and item models!
56+
- Locators: Run commands relative to a locators position via keyframes.
57+
- Camera Plugin Support: Install the [Official Camera Plugin](https://www.blockbench.net/plugins/cameras) to create cinematic camera paths with ease!
58+
- Animation Tweening: Create smooth transitions between animations.
59+
- Many different configuration options.
60+
- Complete Documentation at https://animated-java.github.io/
4161

42-
Then, paste this URL into the box that appears: https://animated-java.dev/api/builds/main/animated_java.js
62+
And much more!
4363

44-
![URL](https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/url.png)
64+
# How to Install
4565

46-
Click Confirm, and success! You've just installed Animated Java.
66+
Follow our guide [here](https://animated-java.github.io/docs/getting-started/installing-animated-java) for detailed instructions on how to install the latest release of Animated Java.
4767

4868
# Getting Started
4969

50-
Check out the [Getting Started](https://animated-java.dev/docs/getting_started) page either online or in-app for detailed information on getting started with Animated Java.
70+
Check out the [Getting Started](https://animated-java.github.io/docs/getting-started/installing-animated-java) page of our documentation to learn how to use Animated Java.
5171

5272
# Contributing to Animated Java
5373

74+
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](https://discord.com/invite/jFgY4PXZfp) before starting work on them. So that we can ensure that your contributions align with the goals of the project.
75+
5476
## Prerequisites
5577

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

80+
- [Blockbench](https://www.blockbench.net/)
5881
- [Node.js](https://nodejs.org/en/)
5982
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
6083

6184
## Setting up the Development Environment
6285

6386
1. Clone the repository.
6487
2. Run `yarn install` to install dependencies.
65-
3. Open up `types/blockbench-types.d.ts` and uncomment the first line, then comment out the second line.
66-
4. Run `yarn build:dev` to start the development environment.
67-
5. Open Blockbench, then go to `File > Plugins > Load Plugin From File` and select the `animated_java.js` file from your local repo (`dist/animated-java.js`).
88+
3. Open up `types/blockbench-types.d.ts` and replace the content of the file with the following:
89+
```ts
90+
/// <reference types="blockbench-types"/>
91+
```
92+
4. Run `yarn build:dev` to start the development environment, which will watch for changes and recompile the plugin.
93+
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`).
94+
6. That's it! You're ready to start developing.
6895

69-
## Adding Localizations
96+
Note that whenever you make changes, you must reload Blockbench as a whole for the changes to function as expected.
7097

71-
1. Copy the `en.yaml` file in `src/lang/` and rename it to match the language you're translating to.
72-
2. Translate! Note that you should be testing your translations as you go in Blockbench.
73-
3. Once you're done translating and testing, open a pull request with your changes.
98+
You can use `Ctrl + Shift + R` to reload Blockbench.
7499

75-
# Creating a Custom Exporter
100+
## Adding Localizations
76101

77-
We have a guide on how to create an external exporter for Animated Java [here](https://github.com/Animated-Java/animated-java-exporter-plugin-template).
102+
1. Follow the steps above to set up the development environment.
103+
2. Duplicate `src/lang/en.yml` and rename it to match the language you're translating to. (e.g. `fr.yml` for French)
104+
3. Start Translating! Make sure to check your changes in Blockbench to ensure they display correctly.
105+
4. Once you're done translating, open a pull request with your changes.

0 commit comments

Comments
 (0)