@coderook/cli 0.34.10 → 0.35.0

package/.claude-plugin/plugin.json

@@ -2,7 +2,7 @@
   "name": "coderook",
   "displayName": "CodeRook",
   "description": "Save, browse and restore whole-snapshot versions of a project on CodeRook, with cbx or plain git, from Claude Code.",
-  "version": "0.34.10",
+  "version": "0.35.0",
   "author": {
     "name": "ACCA Gaming Productions",
     "url": "https://coderook.com"

package/README.md

@@ -462,6 +462,46 @@ https://api.coderook.com/v1/public/projects/OWNER/SLUG/releases
 https://api.coderook.com/v1/public/projects/OWNER/SLUG/updates      electron-updater's generic provider
 ```
 
+## Mod repositories for games
+
+A mod repository is where a game's players get mods from. The game's maker
+sets one up and its rules; modders publish with their own accounts; nothing is
+listed until it passes those rules and a malware scan.
+
+```
+cbx mods create my-game --name "My Game" --allow .png,.ogg,.json --nested .pak
+cbx mods builds my-game --new                 a build secret for the game, shown once
+cbx mods builds my-game --register secret.bin or your own, never printed
+cbx mods info my-game                         the address and public key to pin
+cbx mods settings my-game --uploads owner     change the rules
+```
+
+Rules: `--allow` and `--block` for file types (programs and scripts such as
+`.exe`, `.dll`, `.ps1` and `.js` are refused in every repository, and so is a
+file that is really a program whatever it is called), `--nested` for archive
+types that are opened and checked too, `--manifest` and `--fields` for the
+manifest each part carries (`mod.json` by default) and which of its fields must
+match, `--max-part`, `--max-files`, `--max-parts` and `--max-ratio` for size,
+and `--uploads anyone|owner`.
+
+```
+cbx mods publish ./BetterTrees --repo my-game              zip, upload, wait for the checks
+cbx mods publish ./HD-Art --repo my-game --part animals    one part of a bigger mod
+cbx mods list my-game                                      your mods and how their checks went
+cbx mods remove better-trees --repo my-game
+```
+
+`publish` reads the folder's manifest for the mod's id, name, folder and
+version (`--id`, `--name`, `--folder` and `--version` override it), writes the
+manifest the repository expects into the zip, uploads in pieces that are
+retried, and waits up to 30 minutes for the result; `--no-wait` returns
+straight away. A rejected part says what was wrong, file by file.
+
+The owner also has `cbx mods reports`, `cbx mods block <username> --take-down`,
+`cbx mods list --all`, `cbx mods remove --as-owner` and `cbx mods delete`.
+How the game signs its requests and checks the catalogue is at
+<https://coderook.com/docs#mod-repositories>.
+
 ## Building for every platform
 
 ```