Merge branch 'beta' into audioCleanUp

.env.beta

@@ -1,6 +1,6 @@
 VITE_BYPASS_LOGIN=0
 VITE_BYPASS_TUTORIAL=0
-VITE_SERVER_URL=https://api.beta.pokerogue.net
+VITE_SERVER_URL=https://apibeta.pokerogue.net
 VITE_DISCORD_CLIENT_ID=1248062921129459756
 VITE_GOOGLE_CLIENT_ID=955345393540-2k6lfftf0fdnb0krqmpthjnqavfvvf73.apps.googleusercontent.com
-VITE_I18N_DEBUG=1
+VITE_I18N_DEBUG=0

.env.development

@@ -3,5 +3,5 @@ VITE_BYPASS_TUTORIAL=0
 VITE_SERVER_URL=http://localhost:8001
 VITE_DISCORD_CLIENT_ID=1234567890
 VITE_GOOGLE_CLIENT_ID=1234567890
-VITE_I18N_DEBUG=1
+VITE_I18N_DEBUG=0
 VITE_PORT=8000

.github/CODEOWNERS

@@ -5,41 +5,3 @@
 
 # github actions/templates etc. - Dev Leads
 /.github @pagefaultgames/dev-leads
-
-# --- Translations ---
-
-# all translations - Translation Leads
-/src/locales @pagefaultgames/translation-leads
-
-# Catalan (Spain/Spanish)
-/src/locales/ca_ES @pagefaultgames/catalan-translation-team
-
-# German
-/src/locales/de @pagefaultgames/german-translation-team
-
-# English
-/src/locales/en @pagefaultgames/english-translation-team
-
-# Spanish
-/src/locales/es @pagefaultgames/spanish-translation-team
-
-# French
-/src/locales/fr @pagefaultgames/french-translation-team
-
-# Italian
-/src/locales/it @pagefaultgames/italian-translation-team
-
-# Japenese
-/src/locales/ja @pagefaultgames/japanese-translation-team
-
-# Korean
-/src/locales/ko @pagefaultgames/korean-translation-team
-
-# Brasilian (Brasil/Portuguese)
-/src/locales/pt_BR @pagefaultgames/portuguese_br-translation-team
-
-# Chinese (simplified)
-/src/locales/zh_CN @pagefaultgames/chinese_simplified-translation-team
-
-# Chinese (traditional)
-/src/locales/zh_TW @pagefaultgames/chinese_traditional-translation-team 

.github/FUNDING.yml

@@ -1 +1 @@
-github: patapancakes
+github: pagefaultgames

.github/workflows/deploy-beta.yml

@@ -11,6 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
       - uses: actions/setup-node@v4
         with:
           node-version: "20"

.github/workflows/deploy.yml

@@ -1,8 +1,12 @@
-name: Deploy
+name: Deploy Main
 
 on:
-  push: {}
-  pull_request: {}
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   deploy:
@@ -10,6 +14,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
       - uses: actions/setup-node@v4
         with:
           node-version: "20"
@@ -20,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
@@ -28,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:

.github/workflows/eslint.yml

@@ -22,6 +22,8 @@ jobs:
     steps:
       - name: Check out Git repository  # Step to check out the repository
         uses: actions/checkout@v4  # Use the checkout action version 4
+        with:
+          submodules: 'recursive'
 
       - name: Set up Node.js  # Step to set up Node.js environment
         uses: actions/setup-node@v4  # Use the setup-node action version 4

.github/workflows/github-pages.yml

@@ -26,6 +26,7 @@ jobs:
       - name: Checkout repository for Typedoc
         uses: actions/checkout@v3
         with:
+          submodules: 'recursive'
           path: pokerogue_docs
 
       - name: Install OS package

.github/workflows/test-shard-template.yml

@@ -20,6 +20,8 @@ jobs:
     steps:
       - name: Check out Git repository
         uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:

.github/workflows/tests.yml

@@ -22,6 +22,7 @@ jobs:
       - name: Check out Git repository
         uses: actions/checkout@v4
         with:
+          submodules: 'recursive'
           path: tests-action
       - name: Set up Node.js
         uses: actions/setup-node@v4

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "public/locales"]
+	path = public/locales
+	url = https://github.com/pagefaultgames/pokerogue-locales

README.md

@@ -17,13 +17,21 @@ 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
 
 **How do I test a new _______?**
 - In the `src/overrides.ts` file there are overrides for most values you'll need to change for testing
 
+**How do I retrieve the translations?**
+- The translations were moved to the [dedicated translation repository](https://github.com/pagefaultgames/pokerogue-locales) and are now applied as a submodule in this project.
+- The command to retrieve the translations is `git submodule update --init --recursive`. If you still struggle to get it working, please reach out to #dev-corner channel in Discord.
 
 ## 🪧 To Do
 Check out [Github Issues](https://github.com/pagefaultgames/pokerogue/issues) to see how can you help us!

create-test-boilerplate.js

@@ -1,82 +1,120 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
 /**
- * This script creates a test boilerplate file for a move or ability.
- * @param {string} type - The type of test to create. Either "move", "ability",
- * or "item".
- * @param {string} fileName - The name of the file to create.
- * @example npm run create-test move tackle
+ * This script creates a test boilerplate file in the appropriate 
+ * directory based on the type selected.
+ * @example npm run create-test
  */
 
+import fs from "fs";
+import inquirer from "inquirer";
+import path from "path";
+import { fileURLToPath } from "url";
+
 // Get the directory name of the current module file
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
+const typeChoices = ["Move", "Ability", "Item", "Mystery Encounter"];
 
-// Get the arguments from the command line
-const args = process.argv.slice(2);
-const type = args[0]; // "move" or "ability"
-let fileName = args[1]; // The file name
+/**
+ * Prompts the user to select a type via list.
+ * @returns {Promise<{selectedOption: string}>} the selected type
+ */
+async function promptTestType() {
+  const typeAnswer = await inquirer.prompt([
+    {
+      type: "list",
+      name: "selectedOption",
+      message: "What type of test would you like to create:",
+      choices: [...typeChoices, "EXIT"],
+    },
+  ]);
 
-if (!type || !fileName) {
-  console.error('Please provide a type ("move", "ability", or "item") and a file name.');
-  process.exit(1);
+  if (typeAnswer.selectedOption === "EXIT") {
+    console.log("Exiting...");
+    return process.exit();
+  } else if (!typeChoices.includes(typeAnswer.selectedOption)) {
+    console.error(`Please provide a valid type (${typeChoices.join(", ")})!`);
+    return await promptTestType();
+  }
+
+  return typeAnswer;
 }
 
-// Convert fileName from kebab-case or camelCase to snake_case
-fileName = fileName
-  .replace(/-+/g, '_') // Convert kebab-case (dashes) to underscores
-  .replace(/([a-z])([A-Z])/g, '$1_$2') // Convert camelCase to snake_case
+/**
+ * Prompts the user to provide a file name.
+ * @param {string} selectedType
+ * @returns {Promise<{userInput: string}>} the selected file name
+ */
+async function promptFileName(selectedType) {
+  const fileNameAnswer = await inquirer.prompt([
+    {
+      type: "input",
+      name: "userInput",
+      message: `Please provide the name of the ${selectedType}:`,
+    },
+  ]);
+
+  if (!fileNameAnswer.userInput || fileNameAnswer.userInput.trim().length === 0) {
+    console.error("Please provide a valid file name!");
+    return await promptFileName(selectedType);
+  }
+
+  return fileNameAnswer;
+}
+
+/**
+ * Runs the interactive create-test "CLI"
+ * @returns {Promise<void>}
+ */
+async function runInteractive() {
+  const typeAnswer = await promptTestType();
+  const fileNameAnswer = await promptFileName(typeAnswer.selectedOption);
+
+  const type = typeAnswer.selectedOption.toLowerCase();
+  // Convert fileName from kebab-case or camelCase to snake_case
+  const fileName = fileNameAnswer.userInput
+    .replace(/-+/g, "_") // Convert kebab-case (dashes) to underscores
+    .replace(/([a-z])([A-Z])/g, "$1_$2") // Convert camelCase to snake_case
+    .replace(/\s+/g, '_') // Replace spaces with underscores
     .toLowerCase(); // Ensure all lowercase
+  // Format the description for the test case
 
-// Format the description for the test case
-const formattedName = fileName
-  .replace(/_/g, ' ')
-  .replace(/\b\w/g, char => char.toUpperCase());
-
-// Determine the directory based on the type
-let dir;
-let description;
-if (type === 'move') {
-  dir = path.join(__dirname, 'src', 'test', 'moves');
+  const formattedName = fileName.replace(/_/g, " ").replace(/\b\w/g, (char) => char.toUpperCase());
+  // Determine the directory based on the type
+  let dir;
+  let description;
+  switch (type) {
+    case "move":
+      dir = path.join(__dirname, "src", "test", "moves");
       description = `Moves - ${formattedName}`;
-} else if (type === 'ability') {
-  dir = path.join(__dirname, 'src', 'test', 'abilities');
+      break;
+    case "ability":
+      dir = path.join(__dirname, "src", "test", "abilities");
       description = `Abilities - ${formattedName}`;
-} else if (type === "item") {
-  dir = path.join(__dirname, 'src', 'test', 'items');
+      break;
+    case "item":
+      dir = path.join(__dirname, "src", "test", "items");
       description = `Items - ${formattedName}`;
-} else {
-  console.error('Invalid type. Please use "move", "ability", or "item".');
+      break;
+    case "mystery encounter":
+      dir = path.join(__dirname, "src", "test", "mystery-encounter", "encounters");
+      description = `Mystery Encounter - ${formattedName}`;
+      break;
+    default:
+      console.error(`Invalid type. Please use one of the following: ${typeChoices.join(", ")}.`);
       process.exit(1);
-}
+  }
 
-// Ensure the directory exists
-if (!fs.existsSync(dir)) {
-  fs.mkdirSync(dir, { recursive: true });
-}
-
-// Create the file with the given name
-const filePath = path.join(dir, `${fileName}.test.ts`);
-
-if (fs.existsSync(filePath)) {
-  console.error(`File "${fileName}.test.ts" already exists.`);
-  process.exit(1);
-}
-
-// Define the content template
-const content = `import { Abilities } from "#enums/abilities";
+  // Define the content template
+  const content = `import { Abilities } from "#enums/abilities";
 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;
   let game: GameManager;
-  const TIMEOUT = 20 * 1000;
 
   beforeAll(() => {
     phaserGame = new Phaser.Game({
@@ -91,20 +129,43 @@ 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 () => {
-    // await game.classicMode.startBattle([Species.MAGIKARP]);
-    // game.move.select(Moves.SPLASH);
-  }, TIMEOUT);
+  it("should do X", async () => {
+    await game.classicMode.startBattle([ Species.FEEBAS ]);
+
+    game.move.select(Moves.SPLASH);
+    await game.phaseInterceptor.to("BerryPhase");
+
+    expect(true).toBe(true);
+  });
 });
 `;
 
-// Write the template content to the file
-fs.writeFileSync(filePath, content, 'utf8');
+  // Ensure the directory exists
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
 
-console.log(`File created at: ${filePath}`);
+  // Create the file with the given name
+  const filePath = path.join(dir, `${fileName}.test.ts`);
+
+  if (fs.existsSync(filePath)) {
+    console.error(`File "${fileName}.test.ts" already exists.`);
+    process.exit(1);
+  }
+
+  // Write the template content to the file
+  fs.writeFileSync(filePath, content, "utf8");
+
+  console.log(`File created at: ${filePath}`);
+}
+
+runInteractive();

eslint.config.js

@@ -41,6 +41,11 @@ export default [
             "keyword-spacing": ["error", { "before": true, "after": true }], // Enforces spacing before and after keywords
             "comma-spacing": ["error", { "before": false, "after": true }], // Enforces spacing after comma
             "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;
+}

lefthook.yml

@@ -14,3 +14,8 @@ pre-push:
     eslint:
       glob: "*.{js,ts,jsx,tsx}"
       run: npx eslint --fix {push_files}
+      
+post-merge:
+  commands:
+    update-submodules:
+      run: git submodule update --init --recursive

package.json

@@ -19,7 +19,8 @@
 		"docs": "typedoc",
 		"depcruise": "depcruise src",
 		"depcruise:graph": "depcruise src --output-type dot | node dependency-graph.js > dependency-graph.svg",
-		"create-test": "node ./create-test-boilerplate.js"
+		"create-test": "node ./create-test-boilerplate.js",
+		"postinstall": "npx lefthook install && npx lefthook run post-merge" 
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.3.0",
@@ -33,13 +34,15 @@
 		"dependency-cruiser": "^16.3.10",
 		"eslint": "^9.7.0",
 		"eslint-plugin-import-x": "^4.2.1",
+		"inquirer": "^11.0.2",
 		"jsdom": "^24.0.0",
 		"lefthook": "^1.6.12",
+		"msw": "^2.4.9",
 		"phaser3spectorjs": "^0.0.8",
 		"typedoc": "^0.26.4",
 		"typescript": "^5.5.3",
 		"typescript-eslint": "^8.0.0-alpha.54",
-		"vite": "^5.3.5",
+		"vite": "^5.4.8",
 		"vite-tsconfig-paths": "^4.3.2",
 		"vitest": "^2.0.4",
 		"vitest-canvas-mock": "^0.3.3"
@@ -49,6 +52,7 @@
 		"crypto-js": "^4.2.0",
 		"i18next": "^23.11.1",
 		"i18next-browser-languagedetector": "^7.2.1",
+		"i18next-http-backend": "^2.6.1",
 		"i18next-korean-postposition-processor": "^1.0.0",
 		"json-stable-stringify": "^1.1.0",
 		"phaser": "^3.70.0",

public/exp-sprites.json

@@ -4633,11 +4633,7 @@
     "690",
     "691",
     "696",
-    "696_3",
-    "696_3",
     "697",
-    "697_3",
-    "697_3",
     "700",
     "704",
     "705_2",

public/images/mystery-encounters/berries_abound_bush.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "berry_bush.png",
+			"image": "berries_abound_bush.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 49,

public/images/mystery-encounters/dark_deal_scientist.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "mad_scientist_m.png",
+			"image": "dark_deal_scientist.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 46,

public/images/mystery-encounters/department_store_sale_lady.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "b2w2_lady.png",
+			"image": "department_store_sale_lady.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 399,

public/images/mystery-encounters/field_trip_teacher.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "teacher.png",
+			"image": "field_trip_teacher.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 43,

public/images/mystery-encounters/fun_and_games_game.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "carnival_game.png",
+			"image": "fun_and_games_game.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 38,

public/images/mystery-encounters/fun_and_games_man.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "carnival_man.png",
+			"image": "fun_and_games_man.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 50,

public/images/mystery-encounters/fun_and_games_wobbuffet.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "carnival_wobbuffet.png",
+			"image": "fun_and_games_wobbuffet.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 45,

public/images/mystery-encounters/mysterious_chest_blue.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "chest_blue.png",
+			"image": "mysterious_chest_blue.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 54,

public/images/mystery-encounters/mysterious_chest_red.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "chest_red.png",
+			"image": "mysterious_chest_red.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 54,

public/images/mystery-encounters/part_timer_crate.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "warehouse_crate.png",
+			"image": "part_timer_crate.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 71,

public/images/mystery-encounters/safari_zone_bait.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "bait.png",
+			"image": "safari_zone_bait.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 14,

public/images/mystery-encounters/safari_zone_mud.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "mud.png",
+			"image": "safari_zone_mud.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 14,

public/images/mystery-encounters/shady_vitamin_dealer.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "b2w2_veteran_m.png",
+			"image": "shady_vitamin_dealer.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 424,

public/images/mystery-encounters/teleporting_hijinks_teleporter.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "teleporter.png",
+			"image": "teleporting_hijinks_teleporter.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 74,

public/images/mystery-encounters/training_session_gear.json

@@ -1,7 +1,7 @@
 {
 	"textures": [
 		{
-			"image": "training_gear.png",
+			"image": "training_session_gear.png",
 			"format": "RGBA8888",
 			"size": {
 				"w": 76,

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
 					}
 				},
 				{