Skip to content

Commit 7e6155c

Browse files
SnaveSutitSnaveSutit
committed
🎨 Massively improve README
1 parent 8864bb3 commit 7e6155c

File tree

4 files changed

+184
-74
lines changed

4 files changed

+184
-74
lines changed

‎CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<div align=center>
2+
<img src="src/assets/icons/animated_java_fancy_icon.svg" width=128/>
3+
<h1>🧑‍💻 Contributing to Animated Java</h1>
4+
</div>
5+
6+
Contributions are always welcome, but please consult @SnaveSutit before starting to avoid duplicates or misalignment of goals. I don't want you to waste all that time and effort on a PR that gets refused!
7+
8+
<div align=center>
9+
<kbd>Thank you! ❤️</kbd>
10+
</div>
11+
12+
<br/>
13+
14+
<h1 align=center>💻 Setting up the Development Environment</h1>
15+
16+
### 🛠️ Prerequisites
17+
18+
- #### Required
19+
20+
- [Node.js](https://nodejs.org/en/)
21+
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
22+
- [Git](https://git-scm.com/)
23+
24+
- #### Recommended
25+
26+
- [VSCode](https://code.visualstudio.com/)
27+
> (or any other code editor, but this project has configurations for VSCode)
28+
- [Blockbench](https://www.blockbench.net/)
29+
> The repository includes [Envbench](https://github.com/SnaveSutit/envbench) to create and manage a dev instance of Blockbench, So installing Blockbench separately is not strictly required.
30+
- [SnaveSutit's Blockbench Types](https://github.com/SnaveSutit/blockbench-types)
31+
> Bleeding edge types for Blockbench plugins.<br/>Install via `yarn add -D https://github.com/SnaveSutit/blockbench-types.git`
32+
- [GitButler](https://gitbutler.com/)
33+
> A Git client for simultaneous branches on top of your existing workflow.
34+
35+
## 🖇️ Cloning the Repository
36+
37+
1. Clone the repository via git
38+
39+
> [How do I clone a repository?](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
40+
41+
2. Run `yarn install` to install dependencies.
42+
43+
3. Open up `src/blockbenchTypes.d.ts` and replace the first line with the following:
44+
45+
```ts
46+
/// <reference types="blockbench-types"/>
47+
```
48+
49+
> By default this references my local fork of the Blockbench types to quickly add / adjust types as needed. So you need to adjust this to the official Blockbench types, or your own fork, if you're not me.
50+
51+
4. Run `yarn dev` to start the development environment, which will watch for changes and recompile the plugin.
52+
53+
5. Open a new terminal, or click `Split` if you're in VSCode's terminal, and run `yarn start` to start the development instance of Blockbench.
54+
55+
6. That's it! You're ready to start developing.
56+
57+
> [!IMPORTANT]
58+
> Note that whenever you make changes, reloading just the plugins won't be enough, you must fully reload Blockbench for the plugin to function as expected.<br>
59+
> You can use <kbd><kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + <kbd>R</kbd></kbd>
60+
> to reload Blockbench, or run `Blockbench.reload()` in the dev-tools console.
61+
62+
## 💬 Adding Localizations
63+
64+
1. Follow the instructions for [Cloning the Repository](#🖇️-cloning-the-repository).
65+
66+
2. Duplicate `src/lang/en.yml` and rename it to match the language you're translating to. (e.g. `fr.yml` for French).
67+
68+
> See [this page](https://github.com/JannisX11/blockbench/tree/master/lang) for the list of languages Blockbench supports.
69+
70+
3. Start Translating! Make sure to check your changes in Blockbench to ensure they work correctly.
71+
72+
> [!IMPORTANT]
73+
> You will see strings that have curly brackets surrounding a number (`{0}`) in them, these are placeholders that indicate where variables should inserted into a string. Make sure to keep them in your translations!
74+
75+
4. Once you're done translating, open a pull request with your changes.

‎README.md

Lines changed: 86 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,109 @@
11
<div align=center>
2-
<img src="https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/animated_java_icon.svg" width=128/>
3-
<h1 >Animated Java
4-
</h1>
5-
</div>
6-
<div align="center">
7-
<img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FAnimated-Java%2Fanimated-java%2Frefs%2Fheads%2Fmain%2Fpackage.json&query=display_version&style=flat-square&label=%20&color=%2300000000&link=https%3A%2F%2Fbuilds.animated-java.dev%2Flatest">
8-
<img alt="Total Downloads" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fblckbn.ch%2Fapi%2Fstats%2Fplugins%3Fweeks%3D1000&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">
9-
<a href="https://discord.com/invite/jFgY4PXZfp"><img alt="Discord" src="https://img.shields.io/discord/785339959518953482?style=flat-square&logo=discord&label=%20&color=%2300aced00"></a>
10-
<img alt="Static Badge" src="https://img.shields.io/badge/Ko--Fi?style=flat-square&logo=kofi&label=Support%20Us!&labelColor=%2300aced00&color=%2300aced00&link=https%3A%2F%2Fko-fi.com%2Fsnavesutit">
2+
<img src="src/assets/icons/animated_java_fancy_icon.svg" alt="Animated Java Icon" width="180px">
3+
<br/>
4+
<br/>
5+
<picture>
6+
<source media="(prefers-color-scheme: light)" srcset="src/assets/animated_java_title.svg"/>
7+
<img src="src/assets/banners/animated_java_title_banner.svg" alt="Animated Java" width="400px"/>
8+
</picture>
119
</div>
1210
<h3 align="center">
13-
A Blockbench plugin that makes complex animation a breeze in Minecraft: Java Edition.
11+
<i>Effortlessly craft complex animations in Minecraft: Java Edition</i>
1412
</h3>
1513

16-
# What is Animated Java?
14+
<br/>
15+
<div align="center">
16+
<kbd>
17+
<a href="https://builds.animated-java.dev/latest">
18+
<img alt="Latest Release" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FAnimated-Java%2Fanimated-java%2Frefs%2Fheads%2Fmain%2Fpackage.json&query=display_version&style=flat-square&label=%20&color=%2300000000">
19+
</a>
20+
</kbd>
21+
<kbd>
22+
<img alt="Downloads in Blockbench" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fblckbn.ch%2Fapi%2Fstats%2Fplugins%3Fweeks%3D1000&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">
23+
</kbd>
24+
<kbd>
25+
<a href="https://animated-java.dev/discord">
26+
<img alt="Discord Server" src="https://img.shields.io/discord/785339959518953482?style=flat-square&logo=discord&label=%20&color=%2300aced00">
27+
</a>
28+
</kbd>
29+
<kbd>
30+
<a href="https://ko-fi.com/snavesutit">
31+
<img alt="Support Me on Ko-Fi!" src="https://img.shields.io/badge/Ko--Fi?style=flat-square&logo=kofi&label=Support%20Me!&labelColor=%2300aced00&color=%2300aced00&link=https%3A%2F%2Fko-fi.com%2Fsnavesutit">
32+
</a>
33+
</kbd>
34+
</div>
35+
36+
---
37+
38+
<br/>
39+
40+
# ❔ What is Animated Java?
41+
42+
Animated Java is a cutting-edge Blockbench plugin designed for Minecraft: Java Edition mapmakers and Data Pack developers. By leveraging Blockbench's familiar interface, and the power of Java Edition's Data Pack and Resource Pack systems, Animated Java allows you to create complex animations with ease!
43+
44+
<br/>
45+
46+
# ✨ Key Features
47+
48+
- **Function API** - Simple, yet powerful, API for summoning, and controlling animated models.
49+
50+
- **Variants** - Swap between different textures in-game.
51+
52+
- **Text Displays** - Preview, edit, and animate text displays in Blockbench.
53+
54+
- **Keyframe Easing Curves** - Create smooth animations with ease.
55+
56+
- **Locators** - Execute commands using Command Keyframes, teleport entities in an animation, and more.
57+
58+
- **Animation Tweening** - Smoothly transition be<ins>tween</ins> animations.
59+
60+
- **Camera Support** - Install the [Official Camera Plugin](https://www.blockbench.net/plugins/cameras) to create cinematic camera paths with ease.
1761

18-
Animated Java is a plugin for Blockbench that allows you to create custom animations and models
19-
for Vanilla Minecraft. It uses the power of Java Edition's Data Pack and Resource Pack systems
20-
to bring your creations to life!
62+
- **Well Optimized** - Hours of effort have been poured into making Animated Java's Data Pack as low-impact as possible.
2163

22-
## Features
64+
- **Resource Packs are Optional** - Animate Vanilla block and item models using Item and Block Display entities.
2365

24-
- Variants: Swap between different textures in-game.
25-
- Highly optimized: Hours of performance tests and optimization tweaks have gone into Animated
26-
Java's Exported Data Pack to make sure it has as little performance impact as possible.
27-
- Custom easing functions for keyframes.
28-
- Limited Molang support. If Blockbench can render it, Animated Java can bake it.
29-
- Text Display previewing and animation support.
30-
- Resource Pack-less exporting. Animate Vanilla block and item models!
31-
- Locators: Run commands relative to a locators position via keyframes.
32-
- Camera Plugin Support: Install the [Official Camera Plugin](https://www.blockbench.net/plugins/cameras) to create cinematic camera paths with ease!
33-
- Animation Tweening: Create smooth transitions between animations.
34-
- Many different configuration options.
35-
- Complete Documentation at https://animated-java.dev
66+
- **Molang Support** - If Blockbench can render your Molang expressions in the preview, you can use it in Animated Java.
3667

37-
And much more!
68+
<br/>
3869

39-
# How to Install
70+
# 📦 Installation
4071

41-
Follow our guide [here](https://animated-java.dev/docs/getting-started/installing-animated-java) for detailed instructions on how to install the latest release of Animated Java.
72+
- ❔ [Getting Started](https://animated-java.dev/docs/getting-started/using-animated-java)
73+
- 📚 [Documentation](https://animated-java.dev/docs)
74+
- 🕸️ [Website](https://animated-java.dev)
75+
- 🗣️ [Discord](https://animated-java.dev/discord)
4276

43-
# Getting Started
77+
<br/>
4478

45-
Check out the [Getting Started](https://animated-java.dev/docs/getting-started/installing-animated-java) page of our documentation to learn how to use Animated Java.
79+
# 💬 Testimonials
4680

47-
# Contributing to Animated Java
81+
> <q>_I love AJ 3000!_</q>
82+
> — [MrMakistein](https://www.youtube.com/@McMakistein)
4883
49-
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.
84+
> <q>_Wonderful tool, thank you for contributing to the creative possibilities in this game!_</q>
85+
> — [Leroidesafk](https://www.curseforge.com/members/leroidesafk/projects)
5086
51-
## Prerequisites
87+
> <q>_Super thankful for AJ Snave! Its allowed me to create some insane sh\*\*_</q>
88+
> — [phiac](https://www.youtube.com/channel/UCh2OK3oqxy-_azT-iwcSCag)
5289
53-
Things you'll need installed before you can setup the development environment
90+
> <q>_Thank you for the lovely tool!_</q>
91+
> — [LeCarbonator](https://github.com/LeCarbonator)
5492
55-
- [Blockbench](https://www.blockbench.net/)
56-
- [Node.js](https://nodejs.org/en/)
57-
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
93+
<br/>
5894

59-
## Setting up the Development Environment
95+
# 🧑‍💻 Contributing
6096

61-
1. Clone the repository.
62-
2. Run `yarn install` to install dependencies.
63-
3. Open up `types/blockbench-types.d.ts` and replace the content of the file with the following:
64-
```ts
65-
/// <reference types="blockbench-types"/>
66-
```
67-
4. Run `yarn dev` to start the development environment, which will watch for changes and recompile the plugin.
68-
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`).
69-
6. That's it! You're ready to start developing.
97+
Contributions are always welcome! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
7098

71-
> [!NOTE]
72-
> Note that whenever you make changes, you must reload Blockbench as a whole for the changes to function as expected.<br>
73-
> You can use `Ctrl + Shift + R` to reload Blockbench.
99+
<br/>
74100

75-
## Adding Localizations
101+
# ⭐ Star History
76102

77-
1. Follow the steps above to set up the development environment.
78-
2. Duplicate `src/lang/en.yml` and rename it to match the language you're translating to. (e.g. `fr.yml` for French)
79-
3. Start Translating! Make sure to check your changes in Blockbench to ensure they display correctly.
80-
4. Once you're done translating, open a pull request with your changes.
103+
<a href="https://star-history.com/#animated-java/animated-java&Date" alt="test">
104+
<picture>
105+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=animated-java/animated-java&type=Date&theme=dark" />
106+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=animated-java/animated-java&type=Date" />
107+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=animated-java/animated-java&type=Date" />
108+
</picture>
109+
</a>

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name": "animated_java",
44
"title": "Animated Java",
55
"icon": "icon.svg",
6-
"description": "A Blockbench plugin that makes complex animation a breeze in Minecraft: Java Edition.",
6+
"description": "Effortlessly craft complex animations in Minecraft: Java Edition",
77
"version": "1.6.4",
88
"display_version": "v1.6.4",
99
"min_blockbench_version": "4.12.0",

‎src/plugin/package/about.svelte

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,28 +39,34 @@
3939
<h3 class="animated-java-plugin-page-h3">Features</h3>
4040

4141
<ul>
42-
<li>Variants: Swap between different textures in-game.</li>
4342
<li>
44-
Highly optimized: Hours of performance tests and optimization tweaks have gone into Animated
45-
Java's Exported Data Pack to make sure it has as little performance impact as possible.
43+
<b>Function API</b> - Simple, yet powerful, API for summoning, and controlling animated models.
4644
</li>
47-
<li>Limited Molang support. If Blockbench can render it, Animated Java can animate it.</li>
48-
<li>Text Display previewing and animation support.</li>
49-
<li>Resource Pack-less exporting. Animate Vanilla block and item models!</li>
50-
<li>Locators: Run commands relative to a locators position via keyframes.</li>
45+
<li><b>Variants</b> - Swap between different textures in-game.</li>
46+
<li><b>Text Displays</b> - Preview, edit, and animate text displays in Blockbench.</li>
47+
<li><b>Keyframe Easing Curves</b> - Create smooth animations with ease.</li>
5148
<li>
52-
Camera Plugin Support: Install the <a href="https://www.blockbench.net/plugins/cameras"
53-
>Official Camera Plugin</a
54-
> to create cinematic camera paths with ease!
49+
<b>Locators</b> - Execute commands using Command Keyframes, teleport entities in an animation,
50+
and more.
5551
</li>
56-
<li>Animation Tweening: Create smooth transitions between animations.</li>
57-
<li>Many different configuration options.</li>
52+
<li><b>Animation Tweening</b> - Smoothly transition between animations.</li>
5853
<li>
59-
Complete Documentation at <a href="https://animated-java.dev/docs"
60-
>animated-java.dev/documentation/</a
61-
>
54+
<b>Camera Support</b> - Install the
55+
<a href="https://www.blockbench.net/plugins/cameras">Official Camera Plugin</a> to create cinematic
56+
camera paths with ease.
57+
</li>
58+
<li>
59+
<b>Well Optimized</b> - Hours of effort have been poured into making Animated Java's Data Pack
60+
as low-impact as possible.
61+
</li>
62+
<li>
63+
<b>Resource Packs are Optional</b> - Animate Vanilla block and item models using Item and Block
64+
Display entities.
65+
</li>
66+
<li>
67+
<b>Molang Support</b> - If Blockbench can render your Molang expressions in the preview, you
68+
can use it in Animated Java.
6269
</li>
63-
<li>And much more!</li>
6470
</ul>
6571

6672
<h3 class="animated-java-plugin-page-h3">Getting started</h3>

0 commit comments

Comments
 (0)