Merge branch 'beta' of https://github.com/pagefaultgames/pokerogue into gymteams

.github/workflows/deploy.yml

@@ -1,8 +1,12 @@
-name: Deploy
+name: Deploy Main
 
 on:
-  push: {}
+  push:
-  pull_request: {}
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   deploy:
@@ -22,7 +26,7 @@ jobs:
         env:
           NODE_ENV: production
       - name: Set up SSH
-        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        if: github.event_name == 'push' && github.ref_name == 'main'
         run: |
           mkdir ~/.ssh
           echo "${{ secrets.SSH_PUBLIC_KEY }}" > ~/.ssh/id_ed25519.pub
@@ -30,12 +34,12 @@ jobs:
           chmod 600 ~/.ssh/*
           ssh-keyscan -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts
       - name: Deploy build on server
-        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        if: github.event_name == 'push' && github.ref_name == 'main'
         run: | 
           rsync --del --no-times --checksum -vrm dist/* ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:${{ secrets.DESTINATION_DIR }}
           ssh -t ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "~/prmanifest --inpath ${{ secrets.DESTINATION_DIR }} --outpath ${{ secrets.DESTINATION_DIR }}/manifest.json"
       - name: Purge Cloudflare Cache
-        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        if: github.event_name == 'push' && github.ref_name == 'main'
         id: purge-cache
         uses: NathanVaughn/actions-cloudflare-purge@v3.1.0
         with:

README.md

@@ -17,7 +17,12 @@ If you have the motivation and experience with Typescript/Javascript (or are wil
 2. Run `npm run start:dev` to locally run the project in `localhost:8000`
 
 #### Linting
-We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run eslint` script.
+We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run eslint` script. To view the complete rules, check out the [eslint.config.js](./eslint.config.js) file.
+
+### 📚 Documentation
+You can find the auto-generated documentation [here](https://pagefaultgames.github.io/pokerogue/main/index.html).
+For information on enemy AI, check out the [enemy-ai.md](./docs/enemy-ai.md) file.
+For detailed guidelines on documenting your code, refer to the [comments.md](./docs/comments.md) file.
 
 ### ❔ FAQ
 

create-test-boilerplate.js

@@ -49,7 +49,7 @@ async function promptFileName(selectedType) {
     {
       type: "input",
       name: "userInput",
-      message: `Please provide a file name for the ${selectedType} test:`,
+      message: `Please provide the name of the ${selectedType}:`,
     },
   ]);
 
@@ -110,7 +110,7 @@ import { Moves } from "#enums/moves";
 import { Species } from "#enums/species";
 import GameManager from "#test/utils/gameManager";
 import Phaser from "phaser";
-import { afterEach, beforeAll, beforeEach, describe, it, expect } from "vitest";
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
 
 describe("${description}", () => {
   let phaserGame: Phaser.Game;
@@ -129,15 +129,22 @@ describe("${description}", () => {
   beforeEach(() => {
     game = new GameManager(phaserGame);
     game.override
-      .moveset([Moves.SPLASH])
+      .moveset([ Moves.SPLASH ])
+      .ability(Abilities.BALL_FETCH)
       .battleType("single")
+      .disableCrits()
+      .enemySpecies(Species.MAGIKARP)
       .enemyAbility(Abilities.BALL_FETCH)
       .enemyMoveset(Moves.SPLASH);
   });
 
-  it("test case", async () => {
+  it("should do X", async () => {
-    // await game.classicMode.startBattle([Species.MAGIKARP]);
+    await game.classicMode.startBattle([ Species.FEEBAS ]);
-    // game.move.select(Moves.SPLASH);
+
+    game.move.select(Moves.SPLASH);
+    await game.phaseInterceptor.to("BerryPhase");
+
+    expect(true).toBe(true);
   });
 });
 `;

eslint.config.js

@@ -1,5 +1,5 @@
 import tseslint from '@typescript-eslint/eslint-plugin';
-import stylisticTs from '@stylistic/eslint-plugin-ts'
+import stylisticTs from '@stylistic/eslint-plugin-ts';
 import parser from '@typescript-eslint/parser';
 import importX from 'eslint-plugin-import-x';
 
@@ -16,15 +16,15 @@ export default [
             '@typescript-eslint': tseslint
         },
         rules: {
-            "eqeqeq": ["error", "always"], // Enforces the use of === and !== instead of == and !=
+            "eqeqeq": ["error", "always"], // Enforces the use of `===` and `!==` instead of `==` and `!=`
-            "indent": ["error", 2], // Enforces a 2-space indentation
+            "indent": ["error", 2, { "SwitchCase": 1 }], // Enforces a 2-space indentation, enforces indentation of `case ...:` statements
             "quotes": ["error", "double"], // Enforces the use of double quotes for strings
-            "no-var": "error", // Disallows the use of var, enforcing let or const instead
+            "no-var": "error", // Disallows the use of `var`, enforcing `let` or `const` instead
-            "prefer-const": "error", // Prefers the use of const for variables that are never reassigned
+            "prefer-const": "error", // Enforces the use of `const` for variables that are never reassigned
             "no-undef": "off", // Disables the rule that disallows the use of undeclared variables (TypeScript handles this)
             "@typescript-eslint/no-unused-vars": [ "error", {
                 "args": "none", // Allows unused function parameters. Useful for functions with specific signatures where not all parameters are always used.
-                "ignoreRestSiblings": true // Allows unused variables that are part of a rest property in object destructuring. Useful for excluding certain properties from an object while using the rest.
+                "ignoreRestSiblings": true // Allows unused variables that are part of a rest property in object destructuring. Useful for excluding certain properties from an object while using the others.
             }],
             "eol-last": ["error", "always"], // Enforces at least one newline at the end of files
             "@stylistic/ts/semi": ["error", "always"], // Requires semicolons for TypeScript-specific syntax
@@ -32,15 +32,20 @@ export default [
             "no-extra-semi": ["error"], // Disallows unnecessary semicolons for TypeScript-specific syntax
             "brace-style": "off", // Note: you must disable the base rule as it can report incorrect errors
             "curly": ["error", "all"], // Enforces the use of curly braces for all control statements
-            "@stylistic/ts/brace-style": ["error", "1tbs"],
+            "@stylistic/ts/brace-style": ["error", "1tbs"], // Enforces the following brace style: https://eslint.style/rules/js/brace-style#_1tbs
             "no-trailing-spaces": ["error", { // Disallows trailing whitespace at the end of lines
                 "skipBlankLines": false, // Enforces the rule even on blank lines
                 "ignoreComments": false // Enforces the rule on lines containing comments
             }],
             "space-before-blocks": ["error", "always"], // Enforces a space before blocks
             "keyword-spacing": ["error", { "before": true, "after": true }], // Enforces spacing before and after keywords
-            "comma-spacing": ["error", { "before": false, "after": true }], // Enforces spacing after comma
+            "comma-spacing": ["error", { "before": false, "after": true }], // Enforces spacing after commas
             "import-x/extensions": ["error", "never", { "json": "always" }], // Enforces no extension for imports unless json
+            "array-bracket-spacing": ["error", "always", { "objectsInArrays": false, "arraysInArrays": false }], // Enforces consistent spacing inside array brackets
+            "object-curly-spacing": ["error", "always", { "arraysInObjects": false, "objectsInObjects": false }], // Enforces consistent spacing inside braces of object literals, destructuring assignments, and import/export specifiers
+            "computed-property-spacing": ["error", "never" ], // Enforces consistent spacing inside computed property brackets
+            "space-infix-ops": ["error", { "int32Hint": false }], // Enforces spacing around infix operators
+            "no-multiple-empty-lines": ["error", { "max": 2, "maxEOF": 1, "maxBOF": 0 }], // Disallows multiple empty lines
         }
     }
 ]

global.d.ts

@@ -0,0 +1,14 @@
+import type { SetupServerApi } from "msw/node";
+
+export {};
+
+declare global {
+  /**
+   * Only used in testing.
+   * Can technically be undefined/null but for ease of use we are going to assume it is always defined.
+   * Used to load i18n files exclusively.
+   * 
+   * To set up your own server in a test see `game_data.test.ts`
+   */
+  var i18nServer: SetupServerApi;
+}

package-lock.json

@@ -1,12 +1,13 @@
 {
 	"name": "pokemon-rogue-battle",
-	"version": "1.0.4",
+	"version": "1.1.6",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "pokemon-rogue-battle",
-			"version": "1.0.4",
+			"version": "1.1.6",
+			"hasInstallScript": true,
 			"dependencies": {
 				"@material/material-color-utilities": "^0.2.7",
 				"crypto-js": "^4.2.0",

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "pokemon-rogue-battle",
 	"private": true,
-	"version": "1.0.4",
+	"version": "1.1.6",
 	"type": "module",
 	"scripts": {
 		"start": "vite",

public/images/pokemon/281.json

@@ -399,13 +399,13 @@
 						"x": 0,
 						"y": 6,
 						"w": 36,
-						"h": 55
+						"h": 54
 					},
 					"frame": {
 						"x": 72,
 						"y": 55,
 						"w": 36,
-						"h": 55
+						"h": 54
 					}
 				},
 				{
@@ -420,13 +420,13 @@
 						"x": 0,
 						"y": 6,
 						"w": 36,
-						"h": 55
+						"h": 54
 					},
 					"frame": {
 						"x": 72,
 						"y": 55,
 						"w": 36,
-						"h": 55
+						"h": 54
 					}
 				},
 				{

public/images/pokemon/658-ash.json

@@ -1,41 +1,19 @@
-{
+{ "frames": [
-	"textures": [
+   {
-		{
+    "filename": "0001.png",
-			"image": "658-ash.png",
+    "frame": { "x": 0, "y": 0, "w": 79, "h": 74 },
-			"format": "RGBA8888",
+    "rotated": false,
-			"size": {
+    "trimmed": false,
-				"w": 79,
+    "spriteSourceSize": { "x": 0, "y": 0, "w": 79, "h": 74 },
-				"h": 79
+    "sourceSize": { "w": 79, "h": 74 },
-			},
+    "duration": 100
-			"scale": 1,
+   }
-			"frames": [
+ ],
-				{
+ "meta": {
-					"filename": "0001.png",
+  "app": "https://www.aseprite.org/",
-					"rotated": false,
+  "version": "1.3.7-x64",
-					"trimmed": false,
+  "format": "I8",
-					"sourceSize": {
+  "size": { "w": 79, "h": 74 },
-						"w": 79,
+  "scale": "1"
-						"h": 74
+ }
-					},
-					"spriteSourceSize": {
-						"x": 0,
-						"y": 0,
-						"w": 79,
-						"h": 74
-					},
-					"frame": {
-						"x": 0,
-						"y": 0,
-						"w": 79,
-						"h": 74
-					}
-				}
-			]
-		}
-	],
-	"meta": {
-		"app": "https://www.codeandweb.com/texturepacker",
-		"version": "3.0",
-		"smartupdate": "$TexturePacker:SmartUpdate:936f62fa49ba4d6e402bb2e2eaf2afd0:ed00ba047a44b4bf1309bc147dd000e3:bfbf521a5c7bd80bcd95a96d9789c0dd$"
-	}
 }

public/images/pokemon/658.json

@@ -1,41 +1,19 @@
-{
+{ "frames": [
-	"textures": [
+   {
-		{
+    "filename": "0001.png",
-			"image": "658.png",
+    "frame": { "x": 0, "y": 0, "w": 85, "h": 67 },
-			"format": "RGBA8888",
+    "rotated": false,
-			"size": {
+    "trimmed": false,
-				"w": 75,
+    "spriteSourceSize": { "x": 0, "y": 0, "w": 85, "h": 67 },
-				"h": 75
+    "sourceSize": { "w": 85, "h": 67 },
-			},
+    "duration": 100
-			"scale": 1,
+   }
-			"frames": [
+ ],
-				{
+ "meta": {
-					"filename": "0001.png",
+  "app": "https://www.aseprite.org/",
-					"rotated": false,
+  "version": "1.3.7-x64",
-					"trimmed": false,
+  "format": "I8",
-					"sourceSize": {
+  "size": { "w": 85, "h": 67 },
-						"w": 75,
+  "scale": "1"
-						"h": 65
+ }
-					},
-					"spriteSourceSize": {
-						"x": 0,
-						"y": 0,
-						"w": 75,
-						"h": 65
-					},
-					"frame": {
-						"x": 0,
-						"y": 0,
-						"w": 75,
-						"h": 65
-					}
-				}
-			]
-		}
-	],
-	"meta": {
-		"app": "https://www.codeandweb.com/texturepacker",
-		"version": "3.0",
-		"smartupdate": "$TexturePacker:SmartUpdate:e0b10df331bd4ce6760edab61dee144b:061561c45beff89a92bf0158d065204f:5affcab976148657d36bf4ff3410f92d$"
-	}
 }

public/images/pokemon/688.json

@@ -1,41 +1,18 @@
-{
+{ "frames": [
-	"textures": [
+   {
-		{
+    "filename": "0001.png",
-			"image": "688.png",
+    "frame": { "x": 0, "y": 0, "w": 64, "h": 63 },
-			"format": "RGBA8888",
+    "rotated": false,
-			"size": {
+    "trimmed": false,
-				"w": 52,
+    "spriteSourceSize": { "x": 0, "y": 0, "w": 64, "h": 63 },
-				"h": 52
+    "sourceSize": { "w": 64, "h": 63 }
-			},
+   }
-			"scale": 1,
+ ],
-			"frames": [
+ "meta": {
-				{
+  "app": "https://www.aseprite.org/",
-					"filename": "0001.png",
+  "version": "1.3.7-x64",
-					"rotated": false,
+  "format": "I8",
-					"trimmed": false,
+  "size": { "w": 64, "h": 63 },
-					"sourceSize": {
+  "scale": "1"
-						"w": 41,
+ }
-						"h": 52
-					},
-					"spriteSourceSize": {
-						"x": 0,
-						"y": 0,
-						"w": 41,
-						"h": 52
-					},
-					"frame": {
-						"x": 0,
-						"y": 0,
-						"w": 41,
-						"h": 52
-					}
-				}
-			]
-		}
-	],
-	"meta": {
-		"app": "https://www.codeandweb.com/texturepacker",
-		"version": "3.0",
-		"smartupdate": "$TexturePacker:SmartUpdate:f328f72c414efc6cf463a1254afa75ac:50168e1a7077626f41bdaf5d0b35af74:176060351d0044923af938ba7932a6ef$"
-	}
 }

public/images/pokemon/689.json

@@ -1,41 +1,19 @@
-{
+{ "frames": [
-	"textures": [
+   {
-		{
+    "filename": "0001.png",
-			"image": "689.png",
+    "frame": { "x": 0, "y": 0, "w": 79, "h": 82 },
-			"format": "RGBA8888",
+    "rotated": false,
-			"size": {
+    "trimmed": false,
-				"w": 86,
+    "spriteSourceSize": { "x": 0, "y": 0, "w": 79, "h": 82 },
-				"h": 86
+    "sourceSize": { "w": 79, "h": 82 },
-			},
+    "duration": 100
-			"scale": 1,
+   }
-			"frames": [
+ ],
-				{
+ "meta": {
-					"filename": "0001.png",
+  "app": "https://www.aseprite.org/",
-					"rotated": false,
+  "version": "1.3.7-x64",
-					"trimmed": false,
+  "format": "I8",
-					"sourceSize": {
+  "size": { "w": 79, "h": 82 },
-						"w": 86,
+  "scale": "1"
-						"h": 79
+ }
-					},
-					"spriteSourceSize": {
-						"x": 0,
-						"y": 0,
-						"w": 86,
-						"h": 79
-					},
-					"frame": {
-						"x": 0,
-						"y": 0,
-						"w": 86,
-						"h": 79
-					}
-				}
-			]
-		}
-	],
-	"meta": {
-		"app": "https://www.codeandweb.com/texturepacker",
-		"version": "3.0",
-		"smartupdate": "$TexturePacker:SmartUpdate:1825183d2cc847c000400501e055918b:af535bb92b1490f3ab69be674b3b6fe0:bd0c58ecddcb4af9a0c6e7b39821d971$"
-	}
 }