merge main

.github/workflows/github-pages.yml

@@ -0,0 +1,69 @@
+name: "Github Pages"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  pages:
+    name: Github Pages
+    if: github.repository == 'pagefaultgames/pokerogue'
+    runs-on: ubuntu-latest
+    env:
+      api-dir: ./
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - name: Checkout repository for Typedoc
+        uses: actions/checkout@v3
+        with:
+          path: pokerogue_docs
+
+      - name: Install OS package
+        run: |
+          sudo apt update
+          sudo apt install -y git openssh-client
+
+      - name: Setup Node 20.13.1
+        uses: actions/setup-node@v1
+        with:
+          node-version: 20
+
+      - name: Checkout repository for Github Pages
+        if: github.event_name == 'push'
+        uses: actions/checkout@v3
+        with:
+          path: pokerogue_gh
+          ref: gh-pages
+
+      - name: Install Node.js dependencies
+        working-directory: ${{env.api-dir}}
+        run: |
+          cd pokerogue_docs
+          npm ci
+          npm install typedoc --save-dev
+
+      - name: Generate Typedoc docs
+        working-directory: ${{env.api-dir}}
+        run: |
+          cd pokerogue_docs
+          npx typedoc --out /tmp/docs --githubPages false --entryPoints ./src/
+
+      - name: Commit & Push docs
+        if: github.event_name == 'push'
+        run: |
+          cd pokerogue_gh
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+          mkdir -p $GITHUB_REF_NAME
+          rm -rf $GITHUB_REF_NAME/*
+          cp -r /tmp/docs/. $GITHUB_REF_NAME
+          git add $GITHUB_REF_NAME
+          git commit --allow-empty -m "[skip ci] Deploy docs"
+          git push

.gitignore

@@ -14,8 +14,6 @@ dist-ssr
 
 # Editor directories and files
 .vscode/*
-!.vscode/extensions.json
-!.vscode/settings.json
 .idea
 .DS_Store
 *.suo
@@ -35,4 +33,8 @@ src/data/battle-anim-raw-data*.ts
 src/data/battle-anim-data.ts
 src/overrides.ts
 
-coverage
+coverage
+
+# Local Documentation
+/typedoc
+

index.css

@@ -146,7 +146,9 @@ body {
   margin-left: 10%;
 }
 
-#touchControls:not([data-ui-mode='STARTER_SELECT']) #apad .apadRectBtnContainer > .apadSqBtn, #touchControls:not([data-ui-mode='STARTER_SELECT']) #apad .apadSqBtnContainer > .apadSqBtn {
+#touchControls:not([data-ui-mode='STARTER_SELECT']):not([data-ui-mode='SETTINGS']):not([data-ui-mode='SETTINGS_GAMEPAD']):not([data-ui-mode='SETTINGS_KEYBOARD']) #apad .apadRectBtnContainer > .apadSqBtn,
+#touchControls:not([data-ui-mode='STARTER_SELECT']):not([data-ui-mode='SETTINGS']):not([data-ui-mode='SETTINGS_GAMEPAD']):not([data-ui-mode='SETTINGS_KEYBOARD']) #apad .apadSqBtnContainer
+{
   display: none;
 }
 
@@ -175,4 +177,70 @@ body {
 input:-internal-autofill-selected {
   -webkit-background-clip: text;
   background-clip: text;
+}
+#banner {
+  display: none;
+  position: absolute;
+  top: 33.2%;
+  left: 0;
+  text-align: center;
+  z-index: 1000; /* Ensures the banner is on top of other elements */
+  & > img {
+    opacity: 50%;
+  }
+}
+
+/* Firefox old*/
+@-moz-keyframes blink {
+    0% {
+        opacity:1;
+    }
+    50% {
+        opacity:0;
+    }
+    100% {
+        opacity:1;
+    }
+}
+
+@-webkit-keyframes blink {
+    0% {
+        opacity:1;
+    }
+    50% {
+        opacity:0;
+    }
+    100% {
+        opacity:1;
+    }
+}
+/* IE */
+@-ms-keyframes blink {
+    0% {
+        opacity:1;
+    }
+    50% {
+        opacity:0;
+    }
+    100% {
+        opacity:1;
+    }
+}
+/* Opera and prob css3 final iteration */
+@keyframes blink {
+    0% {
+        opacity:1;
+    }
+    50% {
+        opacity:0;
+    }
+    100% {
+        opacity:1;
+    }
+}
+.blink-image {
+    -moz-animation: blink normal 4s infinite ease-in-out; /* Firefox */
+    -webkit-animation: blink normal 4s infinite ease-in-out; /* Webkit */
+    -ms-animation: blink normal 4s infinite ease-in-out; /* IE */
+    animation: blink normal 4s infinite ease-in-out; /* Opera and prob css3 final iteration */
 }

package.json

@@ -12,7 +12,8 @@
 		"test:cov": "vitest run --coverage",
 		"test:watch": "vitest watch --coverage",
 		"eslint": "eslint --fix .",
-		"eslint-ci": "eslint ."
+		"eslint-ci": "eslint .",
+		"docs": "typedoc"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.3.0",
@@ -29,6 +30,7 @@
 		"lefthook": "^1.6.12",
 		"phaser3spectorjs": "^0.0.8",
 		"pokenode-ts": "^1.20.0",
+		"typedoc": "^0.25.13",
 		"typescript": "^5.4.5",
 		"typescript-eslint": "^7.10.0",
 		"vite": "^4.5.0",