Merge pull request #4087 from pagefaultgames/beta

Release #4

.github/workflows/eslint.yml

@@ -11,6 +11,8 @@ on:
     branches:
       - main  # Trigger on pull request events targeting the main branch
       - beta # Trigger on pull request events targeting the beta branch
+  merge_group:
+    types: [checks_requested]
 
 jobs:
   run-linters:  # Define a job named "run-linters"

.github/workflows/github-pages.yml

@@ -8,6 +8,8 @@ on:
     branches:
       - main
       - beta
+  merge_group:
+    types: [checks_requested]
 
 jobs:
   pages:

.github/workflows/tests.yml

@@ -11,10 +11,12 @@ on:
     branches:
       - main  # Trigger on pull request events targeting the main branch
       - beta # Trigger on pull request events targeting the beta branch
+  merge_group:
+    types: [checks_requested]
 
 jobs:
-  run-tests:  # Define a job named "run-tests"
-    name: Run tests  # Human-readable name for the job
+  run-misc-tests:  # Define a job named "run-tests"
+    name: Run misc tests  # Human-readable name for the job
     runs-on: ubuntu-latest  # Specify the latest Ubuntu runner for the job
 
     steps:
@@ -29,5 +31,75 @@ jobs:
       - name: Install Node.js dependencies  # Step to install Node.js dependencies
         run: npm ci  # Use 'npm ci' to install dependencies
 
-      - name: tests  # Step to run tests
-        run: npm run test:silent
+      - name: pre-test # pre-test to check overrides
+        run: npx vitest run --project pre 
+      - name: test misc
+        run: npx vitest --project misc
+
+  run-abilities-tests:
+    name: Run abilities tests
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install Node.js dependencies
+        run: npm ci
+      - name: pre-test
+        run: npx vitest run --project pre 
+      - name: test abilities
+        run: npx vitest --project abilities
+
+  run-items-tests:
+    name: Run items tests
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install Node.js dependencies
+        run: npm ci
+      - name: pre-test
+        run: npx vitest run --project pre 
+      - name: test items
+        run: npx vitest --project items
+
+  run-moves-tests:
+    name: Run moves tests
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install Node.js dependencies
+        run: npm ci
+      - name: pre-test
+        run: npx vitest run --project pre 
+      - name: test moves
+        run: npx vitest --project moves
+
+  run-battle-tests:
+    name: Run battle tests
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install Node.js dependencies
+        run: npm ci
+      - name: pre-test
+        run: npx vitest run --project pre 
+      - name: test battle
+        run: npx vitest --project battle

create-test-boilerplate.js

@@ -0,0 +1,105 @@
+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
+ */
+
+// Get the directory name of the current module file
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// 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
+
+if (!type || !fileName) {
+    console.error('Please provide both a type ("move", "ability", or "item") and a file name.');
+    process.exit(1);
+}
+
+// Convert fileName from to snake_case if camelCase is given
+fileName = fileName.replace(/([a-z])([A-Z])/g, '$1_$2').toLowerCase();
+
+// 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');
+    description = `Moves - ${formattedName}`;
+} else if (type === 'ability') {
+    dir = path.join(__dirname, 'src', 'test', 'abilities');
+    description = `Abilities - ${formattedName}`;
+} else if (type === "item") {
+    dir = path.join(__dirname, 'src', 'test', 'items');
+    description = `Items - ${formattedName}`;
+} else {
+    console.error('Invalid type. Please use "move", "ability", or "item".');
+    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";
+import GameManager from "#test/utils/gameManager";
+import { SPLASH_ONLY } from "#test/utils/testUtils";
+import Phaser from "phaser";
+import { afterEach, beforeAll, beforeEach, describe, it } from "vitest";
+
+describe("${description}", () => {
+  let phaserGame: Phaser.Game;
+  let game: GameManager;
+  const TIMEOUT = 20 * 1000;
+
+  beforeAll(() => {
+    phaserGame = new Phaser.Game({
+      type: Phaser.HEADLESS,
+    });
+  });
+
+  afterEach(() => {
+    game.phaseInterceptor.restoreOg();
+  });
+
+  beforeEach(() => {
+    game = new GameManager(phaserGame);
+    game.override
+      .battleType("single")
+      .enemyAbility(Abilities.BALL_FETCH)
+      .enemyMoveset(SPLASH_ONLY);
+  });
+
+  it("test case", async () => {
+    // await game.classicMode.startBattle();
+    // game.move.select();
+  }, TIMEOUT);
+});
+`;
+
+// Write the template content to the file
+fs.writeFileSync(filePath, content, 'utf8');
+
+console.log(`File created at: ${filePath}`);

docs/enemy-ai.md

@@ -191,15 +191,15 @@ Now that the enemy Pokémon with the best matchup score is on the field (assumin
 
   We then need to apply a 2x multiplier for the move's type effectiveness and a 1.5x multiplier since STAB applies. After applying these multipliers, the final score for this move is **75**.
 
-- **Swords Dance**: As a non-attacking move, this move's benefit score is derived entirely from the sum of its attributes' benefit scores. Swords Dance's `StatChangeAttr` has a user benefit score of 0 and a target benefit score that, in this case, simplifies to
+- **Swords Dance**: As a non-attacking move, this move's benefit score is derived entirely from the sum of its attributes' benefit scores. Swords Dance's `StatStageChangeAttr` has a user benefit score of 0 and a target benefit score that, in this case, simplifies to
 
   $\text{TBS}=4\times \text{levels} + (-2\times \text{sign(levels)})$
 
   where `levels` is the number of stat stages added by the attribute (in this case, +2). The final score for this move is **6** (Note: because this move is self-targeted, we don't flip the sign of TBS when computing the target score).
 
-- **Crush Claw**: This move is a 75-power Normal-type physical attack with a 50 percent chance to lower the target's Defense by one stage. The additional effect is implemented by the same `StatChangeAttr` as Swords Dance, so we can use the same formulas from before to compute the total TBS and base target score.
+- **Crush Claw**: This move is a 75-power Normal-type physical attack with a 50 percent chance to lower the target's Defense by one stage. The additional effect is implemented by the same `StatStageChangeAttr` as Swords Dance, so we can use the same formulas from before to compute the total TBS and base target score.
 
-  $\text{TBS}=\text{getTargetBenefitScore(StatChangeAttr)}-\text{attackScore}$
+  $\text{TBS}=\text{getTargetBenefitScore(StatStageChangeAttr)}-\text{attackScore}$
 
   $\text{TBS}=(-4 + 2)-(-2\times 2 + \lfloor \frac{75}{5} \rfloor)=-2-11=-13$
 
@@ -221,4 +221,4 @@ When implementing a new move attribute, it's important to override `MoveAttr`'s
 - A move's **user benefit score (UBS)** incentivizes (or discourages) the move's usage in general. A positive UBS gives the move more incentive to be used, while a negative UBS gives the move less incentive.
 - A move's **target benefit score (TBS)** incentivizes (or discourages) the move's usage on a specific target. A positive TBS indicates the move is better used on the user or its allies, while a negative TBS indicates the move is better used on enemies.
 - **The total benefit score (UBS + TBS) of a move should never be 0.** The move selection algorithm assumes the move's benefit score is unimplemented if the total score is 0 and penalizes the move's usage as a result. With status moves especially, it's important to have some form of implementation among the move's attributes to avoid this scenario.
-- **Score functions that use formulas should include comments.** If your attribute requires complex logic or formulas to calculate benefit scores, please add comments to explain how the logic works and its intended effect on the enemy's decision making.
+- **Score functions that use formulas should include comments.** If your attribute requires complex logic or formulas to calculate benefit scores, please add comments to explain how the logic works and its intended effect on the enemy's decision making.

index.css

@@ -23,15 +23,6 @@ body {
   }
 }
 
-#links {
-  width: 90%;
-  text-align: center;
-  position: fixed;
-  bottom: 0;
-  display: flex;
-  justify-content: space-around;
-}
-
 #app {
   display: flex;
   justify-content: center;
@@ -93,7 +84,7 @@ input:-internal-autofill-selected {
 
 @media (orientation: landscape) {
   #touchControls {
-    --controls-size: 20vh; 
+    --controls-size: 20vh;
     --text-shadow-size: 1.3vh;
     --small-button-offset: 4vh;
   }

index.html

@@ -39,7 +39,6 @@
 	</style>
 	<link rel="stylesheet" type="text/css" href="./index.css" />
 	<link rel="manifest" href="./manifest.webmanifest">
-	<script type="text/javascript" src="https://app.termly.io/resource-blocker/c5dbfa2f-9723-4c0f-a84b-2895124e851f?autoBlock=on"></script>
   <script>
     if ("serviceWorker" in navigator) {
       window.addEventListener("load", function () {
@@ -144,13 +143,6 @@
 
 		</div>
 	</div>
-	<div id="tnc-links">
-		<a href="#" class="termly-display-preferences" style="display: none;" target="_blank" rel="noreferrer noopener">Consent Preferences</a>
-		<a href="https://app.termly.io/policy-viewer/policy.html?policyUUID=bc96778b-3f04-4d25-bafc-0deba53e8bec" target="_blank" rel="noreferrer noopener">Privacy Policy</a>
-		<a href="https://app.termly.io/policy-viewer/policy.html?policyUUID=8b523c05-7ec2-4646-9534-5bd61b386e2a" target="_blank" rel="noreferrer noopener">Cookie Disclaimer</a>
-		<a href="https://app.termly.io/policy-viewer/policy.html?policyUUID=b01e092a-9721-477f-8356-45576702ff9e" target="_blank" rel="noreferrer noopener">Terms & Conditions</a>
-		<a href="https://app.termly.io/policy-viewer/policy.html?policyUUID=3b5d1928-3f5b-4ee1-b8df-2d6c276b0bcc" target="_blank" rel="noreferrer noopener">Acceptable Use Policy</a>
-	</div>
 	<script type="module" src="./src/main.ts"></script>
 	<script src="./src/touch-controls.ts" type="module"></script>
 	<script src="./src/debug.js" type="module"></script>

lefthook.yml

@@ -2,6 +2,15 @@ pre-commit:
   parallel: true
   commands:
     eslint:
-      glob: '*.{js,jsx,ts,tsx}'
+      glob: "*.{js,jsx,ts,tsx}"
       run: npx eslint --fix {staged_files}
-      stage_fixed: true
+      stage_fixed: true
+      skip:
+        - merge
+        - rebase
+
+pre-push:
+  commands:
+    eslint:
+      glob: "*.{js,ts,jsx,tsx}"
+      run: npx eslint --fix {push_files}

package.json

@@ -18,7 +18,8 @@
 		"eslint-ci": "eslint .",
 		"docs": "typedoc",
 		"depcruise": "depcruise src",
-		"depcruise:graph": "depcruise src --output-type dot | node dependency-graph.js > dependency-graph.svg"
+		"depcruise:graph": "depcruise src --output-type dot | node dependency-graph.js > dependency-graph.svg",
+		"create-test": "node ./create-test-boilerplate.js"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.3.0",