Animated-Java
diff --git a/‎.eslintrc.json‎
Lines changed: 12 additions & 2 deletions b/‎.eslintrc.json‎
Lines changed: 12 additions & 2 deletions
diff --git a/‎.github/workflows/create-deployment.yml‎
Lines changed: 30 additions & 30 deletions b/‎.github/workflows/create-deployment.yml‎
Lines changed: 30 additions & 30 deletions
diff --git a/‎.github/workflows/validate-pr.yaml‎
Lines changed: 19 additions & 19 deletions b/‎.github/workflows/validate-pr.yaml‎
Lines changed: 19 additions & 19 deletions
diff --git a/‎.gitignore‎
Lines changed: 5 additions & 0 deletions b/‎.gitignore‎
Lines changed: 5 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 25 additions & 4 deletions b/‎README.md‎
Lines changed: 25 additions & 4 deletions
@@ -9,7 +9,7 @@
 		"plugin:@typescript-eslint/recommended",
 		"plugin:@typescript-eslint/recommended-requiring-type-checking"
 	],
-	"ignorePatterns": ["node_modules/", "dist/", "exporters/"],
+	"ignorePatterns": ["node_modules/", "dist/", "exporters/", "tools/", "svelte.config.ts"],
 	"overrides": [
 		{
 			"files": ["*.js", "*.d.ts"],
@@ -37,6 +37,7 @@
 		"@typescript-eslint/ban-types": "warn",
 		"@typescript-eslint/consistent-indexed-object-style": ["warn", "record"],
 		"@typescript-eslint/consistent-generic-constructors": "warn",
+		"@typescript-eslint/no-namespace": "off",
 		"@typescript-eslint/naming-convention": [
 			"warn",
 			{
@@ -106,7 +107,16 @@
 			},
 			{ "selector": "typeLike", "format": ["PascalCase"] },
 			{ "selector": "objectLiteralProperty", "format": null },
-			{ "selector": "default", "format": ["camelCase"] }
+			{ "selector": "default", "format": ["camelCase"] },
+			{
+				"selector": "parameter",
+				"modifiers": ["unused"],
+				"format": null
+			},
+			{
+				"selector": "enumMember",
+				"format": ["UPPER_CASE"]
+			}
 		],
 		"@typescript-eslint/no-unsafe-member-access": "off",
 		"@typescript-eslint/no-unsafe-assignment": "off",
 
@@ -3,37 +3,37 @@
 name: Build and push to site
 
 on:
-  push:
-    branches: [main, experimental]
+    push:
+        branches: [main, experimental]
 
-  workflow_dispatch:
+    workflow_dispatch:
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+    build:
+        runs-on: ubuntu-latest
 
-    steps:
-      - uses: actions/checkout@v1
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: v18.x
-      - name: install yarn
-        run: npm i -g yarn
-      - name: run yarn
-        run: yarn
-      - name: build release
-        run: yarn build:prod
-        env:
-          FLAVOR: ${{ github.ref_name }}
-      - name: create distribution
-        run: node .github/workflows/distribute.cjs ${{ github.ref_name }}
-        env:
-          API_KEY: ${{ secrets.API_KEY }}
-          APP_ID: ${{ secrets.SECRET_KEY }}
-          AUTH_DOMAIN: ${{ secrets.AUTH_DOMAIN }}
-          MEASUREMENT_ID: ${{ secrets.MEASUREMENT_ID }}
-          MESSAGE_SENDER_ID: ${{ secrets.MESSAGE_SENDER_ID }}
-          PROJECT_ID: ${{ secrets.PROJECT_ID }}
-          STORAGE_BUCKET: ${{ secrets.STORAGE_BUCKET }}
-          GITHUB_REF: ${{ github.ref_name }}
+        steps:
+            - uses: actions/checkout@v1
+            - name: Setup Node.js environment
+              uses: actions/setup-node@v3
+              with:
+                  node-version: v18.x
+            - name: install yarn
+              run: npm i -g yarn
+            - name: run yarn
+              run: yarn
+            - name: build release
+              run: yarn build:prod
+              env:
+                  FLAVOR: ${{ github.ref_name }}
+            - name: create distribution
+              run: node .github/workflows/distribute.cjs ${{ github.ref_name }}
+              env:
+                  API_KEY: ${{ secrets.API_KEY }}
+                  APP_ID: ${{ secrets.SECRET_KEY }}
+                  AUTH_DOMAIN: ${{ secrets.AUTH_DOMAIN }}
+                  MEASUREMENT_ID: ${{ secrets.MEASUREMENT_ID }}
+                  MESSAGE_SENDER_ID: ${{ secrets.MESSAGE_SENDER_ID }}
+                  PROJECT_ID: ${{ secrets.PROJECT_ID }}
+                  STORAGE_BUCKET: ${{ secrets.STORAGE_BUCKET }}
+                  GITHUB_REF: ${{ github.ref_name }}
@@ -3,25 +3,25 @@
 name: Validate PR builds successfully.
 
 on:
-  pull_request:
-    branches: [main, experimental]
-  workflow_dispatch:
+    pull_request:
+        branches: [main, experimental]
+    workflow_dispatch:
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+    build:
+        runs-on: ubuntu-latest
 
-    steps:
-      - uses: actions/checkout@v1
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v2.5.1
-        with:
-          node-version: 16.x
-      - name: install yarn
-        run: npm i -g yarn
-      - name: run yarn
-        run: yarn
-      - name: build release
-        run: yarn build:prod
-        env:
-          FLAVOR: pr-test
+        steps:
+            - uses: actions/checkout@v1
+            - name: Setup Node.js environment
+              uses: actions/setup-node@v2.5.1
+              with:
+                  node-version: 16.x
+            - name: install yarn
+              run: npm i -g yarn
+            - name: run yarn
+              run: yarn
+            - name: build release
+              run: yarn build:prod
+              env:
+                  FLAVOR: pr-test
@@ -1,3 +1,6 @@
+# Animated Java Specific
+debug_packs/
+
 # Logs
 logs
 *.log
@@ -102,3 +105,5 @@ dist
 
 # TernJS port file
 .tern-port
+out/linecounter.txt
+out/linecounter.json
@@ -17,6 +17,20 @@
 <br/>
 
 # How to Install
+
+There are two ways to install Animated Java: through the Official Plugin List, or through a direct link.
+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.
+
+## Through the Official Plugin List
+
+Open the Plugins menu in Blockbench (File > Plugins)
+![Plugin Menu](https://raw.githubusercontent.com/Animated-Java/animated-java/experimental/src/assets/plugin_menu.png)
+
+Click on the `Available` tab, Then search for Animated Java in the search bar, and click Install.
+![Search](https://raw.githubusercontent.com/Animated-Java/animated-java/experimental/src/assets/search.png)
+
+## Through the Direct Link
+
 Open the Plugins menu in BlockBench (File > Plugins)
 
 ![Plugin Menu](https://raw.githubusercontent.com/Animated-Java/animated-java/main/src/assets/plugin_menu.png)
@@ -32,25 +46,32 @@ Then, paste this URL into the box that appears: https://animated-java.dev/api/bu
 Click Confirm, and success! You've just installed Animated Java.
 
 # Getting Started
+
 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.
 
 # Contributing to Animated Java
+
 ## Prerequisites
+
 Things you'll need installed before you can setup the development environment
-- [Node.js](https://nodejs.org/en/)
-- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
+
+-   [Node.js](https://nodejs.org/en/)
+-   [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
 
 ## Setting up the Development Environment
 
 1. Clone the repository.
 2. Run `yarn install` to install dependencies.
-3. Run `yarn build:dev` to start the development environment.
-4. 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`).
+3. Open up `types/blockbench-types.d.ts` and uncomment the first line, then comment out the second line.
+4. Run `yarn build:dev` to start the development environment.
+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`).
 
 ## Adding Localizations
+
 1. Copy the `en.yaml` file in `src/lang/` and rename it to match the language you're translating to.
 2. Translate! Note that you should be testing your translations as you go in Blockbench.
 3. Once you're done translating and testing, open a pull request with your changes.
 
 # Creating a Custom Exporter
+
 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).