🔖 v2.0.0

.vscode/extensions.json

@@ -1,3 +1,9 @@
 {
-	"recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint", "svelte.svelte-vscode"]
+	"recommendations": [
+		"esbenp.prettier-vscode",
+		"dbaeumer.vscode-eslint",
+		"svelte.svelte-vscode",
+		"ExodiusStudios.comment-anchors",
+		"SuperAnt.mc-dp-icons"
+	]
 }

.vscode/settings.json

@@ -24,6 +24,11 @@
 		"**/Thumbs.db": true,
 		"**/node_modules": true
 	},
+	"[yaml]": {
+		"editor.tabSize": 2,
+		"editor.insertSpaces": true,
+		"editor.detectIndentation": false
+	},
 	"npm.exclude": ["**/node_modules"],
 	"errorLens.excludePatterns": ["**/node_modules/**/*"],
 	"eslint.validate": ["javascript", "typescript", "svelte"],

.yarn/patches/deepslate-npm-0.19.2-f859599b0a.patch

@@ -0,0 +1,36 @@
+diff --git a/lib/nbt/index.d.ts b/lib/nbt/index.d.ts
+index 69843e7fc1b7c47c89bcd58270289736d2ef1a71..e3bbf5213144a5249a22b351ac6feeee6dd66972 100644
+--- a/lib/nbt/index.d.ts
++++ b/lib/nbt/index.d.ts
+@@ -1,7 +1,7 @@
+-export * from './io/DataInput.js';
+-export * from './io/DataOutput.js';
+-export * from './NbtChunk.js';
+-export * from './NbtFile.js';
+-export * from './NbtRegion.js';
+-export * from './tags/index.js';
++export * from './io/DataInput.js'
++export * from './io/DataOutput.js'
++// export * from './NbtChunk.js';
++// export * from './NbtFile.js';
++// export * from './NbtRegion.js';
++export * from './tags/index.js'
+ //# sourceMappingURL=index.d.ts.map
+diff --git a/lib/nbt/index.js b/lib/nbt/index.js
+index 5906e500f45d93439fc3c683a4cd11135980535b..15de3352ccbfb6f09b266edb0250e7b349324d8a 100644
+--- a/lib/nbt/index.js
++++ b/lib/nbt/index.js
+@@ -1,7 +1,7 @@
+-export * from './io/DataInput.js';
+-export * from './io/DataOutput.js';
+-export * from './NbtChunk.js';
+-export * from './NbtFile.js';
+-export * from './NbtRegion.js';
+-export * from './tags/index.js';
++export * from './io/DataInput.js'
++export * from './io/DataOutput.js'
++// export * from './NbtChunk.js';
++// export * from './NbtFile.js';
++// export * from './NbtRegion.js';
++export * from './tags/index.js'
+ //# sourceMappingURL=index.js.map

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+<div align=center>
+	<img src="src/assets/icons/animated_java_fancy_icon.svg" width=128/>
+	<h1>🧑‍💻 Contributing to Animated Java</h1>
+</div>
+
+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!
+
+<div align=center>
+    <kbd>Thank you! ❤️</kbd>
+</div>
+
+<br/>
+
+<h1 align=center>💻 Setting up the Development Environment</h1>
+
+### 🛠️ Prerequisites
+
+- #### Required
+
+    - [Node.js](https://nodejs.org/en/)
+    - [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
+    - [Git](https://git-scm.com/)
+
+- #### Recommended
+
+    - [VSCode](https://code.visualstudio.com/)
+        > (or any other code editor, but this project has configurations for VSCode)
+    - [Blockbench](https://www.blockbench.net/)
+        > 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.
+    - [SnaveSutit's Blockbench Types](https://github.com/SnaveSutit/blockbench-types)
+        > Bleeding edge types for Blockbench plugins.<br/>Install via `yarn add -D https://github.com/SnaveSutit/blockbench-types.git`
+    - [GitButler](https://gitbutler.com/)
+        > A Git client for simultaneous branches on top of your existing workflow.
+
+## 🖇️ Cloning the Repository
+
+1. Clone the repository via git
+
+    > [How do I clone a repository?](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
+
+2. Run `yarn install` to install dependencies.
+
+3. Open up `src/blockbenchTypes.d.ts` and replace the first line with the following:
+
+    ```ts
+    /// <reference types="blockbench-types"/>
+    ```
+
+    > 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.
+
+4. Run `yarn dev` to start the development environment, which will watch for changes and recompile the plugin.
+
+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.
+
+6. That's it! You're ready to start developing.
+
+> [!IMPORTANT]
+> 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>
+> You can use <kbd><kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + <kbd>R</kbd></kbd>
+> to reload Blockbench, or run `Blockbench.reload()` in the dev-tools console.
+
+## 💬 Adding Localizations
+
+1. Follow the instructions for [Cloning the Repository](#🖇️-cloning-the-repository).
+
+2. Duplicate `src/lang/en.yml` and rename it to match the language you're translating to. (e.g. `fr.yml` for French).
+
+    > See [this page](https://github.com/JannisX11/blockbench/tree/master/lang) for the list of languages Blockbench supports.
+
+3. Start Translating! Make sure to check your changes in Blockbench to ensure they work correctly.
+
+    > [!IMPORTANT]
+    > 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!
+
+4. Once you're done translating, open a pull request with your changes.