hopple 0.1.0-rc.1 → 0.1.0-rc.2

package/README.md

@@ -9,6 +9,7 @@ The command-line tool for game developers:
   uploads it to a Hopple server.
 - `hopple list`, `login`, `logout` and `whoami` manage what you've published
   and who you publish as.
+- `hopple collaborators` chooses who else may publish a game.
 
 It is a dev dependency of the game (`npm install --save-dev hopple`, which
 `hopple create` sets up), run with `npx hopple`. It is one compiled file with
@@ -19,7 +20,7 @@ whatever tool the game uses.
 
 ## The project's config
 
-`dev`, `check` and `publish` work on a **project**: a directory with a hopple
+`dev`, `check`, `publish` and `collaborators` work on a **project**: a directory with a hopple
 config in it. They find it in the current directory, or the nearest one above
 it (like `tsconfig.json`). The config says everything they need to know:
 
@@ -71,6 +72,7 @@ hopple dev     [project] [--port <n>] [--no-build]
 hopple check   [project] [--no-build]
 hopple publish [project] [--server <url>] [--no-build]
 hopple list    [--server <url>]
+hopple collaborators [add <handle> | remove <handle>] [project] [--server <url>]
 hopple login   [--server <url>]
 hopple logout  [--server <url>]
 hopple whoami  [--server <url>]
@@ -169,20 +171,28 @@ npx hopple publish path/to/project
 1. Makes every check `hopple check` makes, so mistakes are caught before
    anything is uploaded.
 2. Uploads the manifest and the page, and publishes them as
-   `<your username>/<manifest id>`, as a new version. The game is listed with
+   `<owner>/<manifest id>`, as a new version. The owner is the manifest's
+   `owner`, or you when it names none; only the owner and the game's
+   collaborators may publish it. The game is listed with
    the manifest's `title` and `description`: to change them, change the
    manifest.
 3. Prints the version's address, whether it is live, and a link that opens that
    exact version.
 
-If you are a trusted user or an admin, the version goes live immediately.
+If you are a trusted user or an admin, the version goes live immediately,
+whoever owns the game.
 Otherwise it waits for an admin to review it, and the previous live version
 (if any) stays in the feed meanwhile.
 
+Nothing is published for an anonymous account. Without `hopple login`, the
+upload is kept and its link works, but it stays out of the feed, and `publish`
+prints a warning saying so. Sign in before or after: either way the game ends
+up in your account.
+
 ### `hopple login`, `logout`, `whoami`, `list`
 
 - The first command that talks to a server starts an **anonymous session**,
-  so you can publish without an account.
+  named `anon-` and three words, so you can upload without an account.
 - `hopple login` signs that same session in. It prints a link and a short
   code, and waits: open the link in a browser where you are signed in to the
   site (or sign in there, any way the site offers), check that the page shows
@@ -191,7 +201,7 @@ Otherwise it waits for an admin to review it, and the previous live version
   Anything you published anonymously from this machine moves into your account.
 - `hopple whoami` shows who you are on that server and how you signed in.
 - `hopple logout` ends the session and forgets it.
-- `hopple list` shows each game you've published, its live version, its
+- `hopple list` shows each game you own or collaborate on, its live version, its
   newest version if different (and whether it is waiting for review), and a
   link to each.
 
@@ -205,6 +215,23 @@ the CLI, under your Hopple player in our usage analytics. Nothing else is
 collected, and nothing is collected on your machine. Set `DO_NOT_TRACK=1` to
 leave your publishes and sign-ins out of those counts.
 
+### `hopple collaborators`
+
+```bash
+npx hopple collaborators              # who else may publish this project's game
+npx hopple collaborators add ada      # let ada publish it too
+npx hopple collaborators remove ada
+```
+
+A collaborator may publish new versions of the game. Nothing else: deleting
+it and choosing who publishes it stay with its owner. The game is the one
+`publish` would upload to, `<owner>/<manifest id>`. Only accounts can be added,
+and each is told in their inbox.
+
+To publish a game you collaborate on, set the manifest's `owner` to the
+owner's handle. Without it, `publish` makes a game of your own instead. Its
+versions go live or wait for review by your own trust, not the owner's.
+
 ## The dev shell
 
 The dev shell runs the game the way real hosts do (same sandbox, same bridge),