Standardize and require ccmod.json

.github/workflows/ccbot.yaml

@@ -0,0 +1,67 @@
+name: Fill CCBot PR info
+
+permissions:
+    contents: read
+    pull-requests: write
+
+on:
+    pull_request:
+        types: [opened]
+
+jobs:
+    completePR:
+        name: Fill CCBot PR info
+        runs-on: ubuntu-latest
+        if: startsWith(github.event.pull_request.title, 'CCBot')
+
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  persist-credentials: false
+                  ref: ${{ github.head_ref }}
+                  token: ${{ secrets.PAT }}
+                  fetch-depth: 0
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+            - working-directory: build/
+              run: npm ci
+
+            - name: Update the database
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                  set -e
+
+                  cd build
+                  OUT="$(npm run start)"
+                  echo "$OUT"
+
+                  OUT="$(echo "$OUT" | tail -1)"
+                  echo "$OUT"
+                  TYPE="$(echo "$OUT" | awk -F'|' '{print $1}')"
+                  ID="$(echo "$OUT" | awk -F'|' '{print $2}')"
+                  VERSION="$(echo "$OUT" | awk -F'|' '{print $3}')"
+                  TITLE="$(echo "$OUT" | awk -F'|' '{print $4}')"
+                  DESCRIPTION="$(echo "$OUT" | awk -F'|' '{print $5}')"
+                  echo "type: $TYPE"
+                  echo "id: $ID"
+                  echo "version: $VERSION"
+                  echo "title: $TITLE"
+                  echo "description: $DESCRIPTION"
+
+                  cd ..
+                  gh pr edit "${{ github.event.pull_request.number }}" --title "CCBot ${TYPE} mod: ${ID}"
+                  gh pr comment "${{ github.event.pull_request.number }}" --body "Mod info:<br>${TITLE} v${VERSION}<br>${DESCRIPTION}"
+
+                  git config --global user.name "${GITHUB_ACTOR}"
+                  git config --global user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
+                  git add -A
+                  git commit -m "CCBot: Fill '${ID}' info"
+                  git status
+
+            - name: Push changes
+              uses: 'ad-m/github-push-action@master'
+              with:
+                  github_token: ${{ secrets.PAT }}
+                  branch: ${{ github.head_ref }}

.github/workflows/ci.yaml

@@ -1,17 +1,23 @@
 name: CI
-on: [push, pull_request, workflow_dispatch]
+on:
+    push:
+    workflow_dispatch:
 
 jobs:
-  check_database:
-    name: Check database
-    runs-on: ubuntu-latest
+    check_database:
+        name: Check database
+        runs-on: ubuntu-latest
 
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v1
-      with:
-        node-version: 15.x
-    - working-directory: build/
-      run: npm ci
-    - working-directory: build/
-      run: npm test
+        if: "!startsWith(github.event.head_commit.message, 'CCBot: ccbot')"
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+            - working-directory: build/
+              run: npm ci
+            - name: npm run test
+              working-directory: build/
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: npm test

.prettierrc.json

@@ -0,0 +1,12 @@
+{
+  "semi": false,
+  "useTabs": false,
+  "tabWidth": 4,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 170,
+  "quoteProps": "as-needed",
+  "bracketSpacing": true,
+  "arrowParens": "avoid"
+}
+

CCMOD-STANDARD.md

@@ -0,0 +1,74 @@
+<!-- markdownlint-disable MD013 MD034 -->
+
+# `ccmod.json` format standard
+
+## Each option explained
+
+- `id` - Mod unique identifier. Not shown to the user
+- `version` - Uses the [semver](https://semver.org/) format
+- `title` - Title shown to users. Can be localized
+- `description` - Description shown to users. Can be localized
+- `homepage` (Optional) - Put your mod homepage link here (don't put your repository link here)
+- `repository` - Put your repository link here. Non GitHub links will be missing some [CCModManager](https://github.com/CCDirectLink/CCModManager) functionality
+- `tags` (Optional) - A list of mod tags. Read what tags are available below in Mod tag list.
+   If the first tag is `library` [CCModManager](https://github.com/CCDirectLink/CCModManager) will hide the mod by default.
+- `authors` - Either a string or an array of mod authors
+- `icons` (Optional) - Mod icon. Currently only the size of 24x24 pixels is supported
+- `dependencies` (Optional) - Require certain mods for the mod to function. Uses the [semver](https://semver.org/) format
+- `plugin` (Optional) - Specifies the javascript file to run
+- `preload` (Optional) - Specifies the javascript file to run at the `preload` stage
+- `postload` (Optional) - Specifies the javascript file to run at the `postload` stage
+- `prestart` (Optional) - Specifies the javascript file to run at the `prestart` stage
+- `poststart` (Optional) - Specifies the javascript file to run at the `poststart` stage
+
+## Mod tag list
+
+- `QoL` - stands for "Quality of Life". Makes the playing experience smoother
+- `player character` - adds new playable characters and/or classes
+- `party member` - adds new playable characters and/or classes
+- `combat arts` - adds new combat arts
+- `pvp duel` - adds a pvp duel
+- `arena` - adds new arena cups
+- `dungeon` - adds a new dungeon
+- `quests` - adds new quests
+- `maps` - adds new content maps
+- `boss` - adds new bosses
+- `puzzle` - adds new puzzles or something puzzle related
+- `ng+` - adds additional ng+ options
+- `cosmetic` - adds any kind of cosmetic things like skins, pets or menu skins
+- `fun` - fun things not necessarily useful
+- `cheats` - do things you're not supposed to do like spawn items or infinite gold
+- `speedrun` - helps speedrunners with speedruns or practice
+- `widget` - adds a [CCUILib](https://github.com/conorlawton/nax-ccuilib) quick menu widget
+- `language` - adds a new language
+- `accessibility` - makes the game more accessible
+- `dev` - helps mod developers create mods
+- `library` - used by other mods. CCModManager hides these mods by default only if this tag is the first element
+- `base` - used by stuff like CCLoader
+- `externaltool` - reserved by tools like [crosscode-map-editor](https://github.com/CCDirectLink/crosscode-map-editor), do not use in mods
+
+## Example `ccmod.json`
+
+```json
+{
+    "id": "crossedeyes",
+    "version": "0.5.7",
+    "title": "CrossedEyes",
+    "description": "Accessibility mod for CrossCode",
+    "repository": "https://github.com/CCDirectLink/CrossedEyes",
+    "tags": ["accessibility"],
+    "authors": ["krypek", "2767mr"],
+    "icons": {
+        "24": "icon.png"
+    },
+    "dependencies": {
+        "input-api": ">=1.0.0",
+        "cc-blitzkrieg": ">=0.4.7",
+        "crosscode": ">=1.4.0"
+    },
+    "plugin": "plugin.js"
+}
+```
+
+Typescript types for this can be found in [CCUTD](https://github.com/CCDirectLink/ultimate-crosscode-typedefs/blob/master/file-types/mod-manifest.d.ts#L5)  
+[JSON Schema](https://json-schema.org/) for `ccmod.json` can be found [here](./ccmod-json-schema.json).

README.md

@@ -1,11 +1,16 @@
 [![CI Status](https://github.com/CCDirectLink/CCModDB/workflows/CI/badge.svg)](https://github.com/CCDirectLink/CCModDB/actions?query=workflow:CI)
 [![Discord Server](https://img.shields.io/discord/382339402338402315.svg?label=Discord%20Server)](https://discord.gg/3Xw69VjXfW)
+
 # CCModDB
+
 Mod database for CrossCode.
 
+## [`ccmod.json` standard](./CCMOD-STANDARD.md)
+
 ## HOW TO ADD YOUR MOD
-Read the [contribution guidelines](CONTRIBUTING.md).
 
+Read the [contribution guidelines](CONTRIBUTING.md).
 
 ## HOW TO GENERATE A SHA256 HASH
+
 Download your mod as a zip folder. Check your sha256 checksum [here](https://emn178.github.io/online-tools/sha256_checksum.html)