Skip to content

Commit e181fa1

Browse files
authored
Merge pull request #23 from theprototype-app/docs-41-int
[docs] 1.32 — roadmaps 40 + 41 + 41b (includes #22)
2 parents d1576b1 + 5b64e58 commit e181fa1

53 files changed

Lines changed: 845 additions & 97 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/animation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Give any object a **clip**: a named animation made of keyframes. Open a door, ru
99

1010
## Opening the timeline
1111

12-
Select an object, then open the **+ Animation** tab — it sits with Flow and the UV editor in the bottom dock, and undocks into a floating window with the ⧉ button.
12+
Select an object, then open the **+ Animation** tab — it sits with Flow and the UV editor in the bottom dock, and the dock's **Undock** button (right end of the tab strip) takes it out as a floating window.
1313

1414
The window has three parts:
1515

‎docs/avatars.md‎

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,44 @@ Nine characters ship with the app: **Knight**, **Mage**, **Rogue**, **Hooded rog
1414

1515
![The nine characters](img/avatars/characters.png)
1616

17-
If you never pick one, you get **Surprise me**: a character chosen from your id, so everyone sees the same one for you.
17+
If you never pick one, you get **Auto**: a character chosen from your id, so everyone sees the same one for you.
1818
The same characters are also an Explorer pack, **Packs ▸ Adventurers**, that you can place in a scene as animated
1919
models (see [Packs](packs.md#adventurers-124)).
2020

2121
## Customize Character
2222

2323
Profile menu (your picture, top right) ▸ **Customize Character** — also **Settings ▸ Interface ▸ Avatars ▸ Customize
24-
character…**. A side panel opens and the camera moves to **your own character**, standing where you are, so you see
25-
yourself the way other people do.
24+
character…**. A drawer opens (a bottom sheet on a phone) and puts **your own character** in a plain **studio**: a
25+
neutral backdrop in your theme's colours, a floor disc and a soft key light.
2626

27-
![The Customize character panel with the camera on your own character](img/avatars/customize-panel.png)
27+
![Customize character on a computer: your character in the studio on the left, the drawer with Show in scene, Surprise me and the presets on the right](img/avatars/studio-desktop.png)
28+
29+
### The studio
30+
31+
The scene is hidden from *your* view only while you customise — nothing in it changes, and other people in the session
32+
keep seeing the scene (and you) as before.
33+
34+
- **Orbit** — drag in the free part of the view to turn the camera around your character like a turntable; the wheel or
35+
a pinch zooms.
36+
- **Show in scene** — the switch at the top of the panel previews your character in the current scene instead, handy to
37+
check how a colour reads against the world. The choice is remembered for next time.
38+
- Your whole character **stays in view** whatever the screen does: resize the drawer or the window, rotate a phone, or
39+
fold or unfold a foldable — the camera re-frames on every layout change.
40+
41+
### Choosing a look
42+
43+
- **Presets** — **Auto** (picked from your id), the nine rigged characters (step through them with ‹ ›) and the
44+
**Classic head**. Picking one shows *its* defaults: its own head, no hat, its own outfit colours.
45+
- **Custom** — change any part (head, hat, outfit or head colour) and a **Custom** entry appears and is selected.
46+
Picking a preset again resets to that preset; picking **Custom** brings your edits back.
47+
- **Surprise me** — a new random character on every press: body, head, hat and colours, never the same one twice in a
48+
row. A surprise you like is your Custom look; press **Apply** to keep it.
49+
50+
The name label and your ping colour and sound are your own preferences: presets and Surprise me leave them alone.
2851

2952
| Section | What you choose |
3053
|---|---|
31-
| **Character** | one of the nine — step through them with ‹ › — or **Surprise me** or **Classic head** |
54+
| **Character** | a preset — **Auto**, one of the nine, or **Classic head** — or **Surprise me**; your own edits are **Custom** |
3255
| **Head** | the character's own head, a stylised **Sphere**, **Box**, **Capsule** or **Cone** in your colour, or **My photo** (your profile picture on a card; needs a profile photo) |
3356
| **Hat** | None, Cap, Top hat or Crown — it sits on whatever head you chose |
3457
| **Colours** | **Outfit** recolours the character's clothes (skin and face keep theirs; **Original** puts them back); **Head** colours a stylised head or the classic avatar |
@@ -40,8 +63,8 @@ narrower — the keyboard works too (focus the edge, then the arrow keys; <kbd>S
4063
camera keeps your character in the part of the screen the drawer leaves free. The size is remembered on this device.
4164

4265
Every change shows on your character at once; nothing reaches other people until you press **Apply**, which saves it and
43-
shows it to everyone. **Cancel**, <kbd>Esc</kbd> or ✕ throw the changes away. Either way the camera returns exactly to
44-
where your view was before you opened it.
66+
shows it to everyone. **Cancel**, <kbd>Esc</kbd>, ✕ or swiping the sheet away throw the changes away. Either way the
67+
camera and the scene come back exactly as they were before you opened it.
4568

4669
## Showing everyone as classic heads
4770

‎docs/code-workspace.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ It opens by itself when you ask for code:
1616
- the dock's **+** menu ▸ **Code**, or the optional `{}` toolbar button (add it with *Customize the toolbar*);
1717
- **Graph JSON** in the workspace's header opens the graph the Node editor is showing.
1818

19-
It docks as a tab at the bottom, beside the Node editor and the Explorer, or floats as a window (**⧉** to float,
20-
**⇩ Dock** to put it back). Everything on this page works in both. In a narrow window or on a phone the
21-
[sidebars](#sidebars) open **over** the editor, one at a time (toggle buttons in the header).
19+
It docks as a tab at the bottom, beside the Node editor and the Explorer, or floats as a window (the dock's **Undock** button to float,
20+
the window's **Dock** to put it back). Everything on this page works in both. In a narrow window or on a phone the
21+
[sidebars](#sidebars) open **over** the editor, one at a time (toggle buttons in the header); on a phone they start
22+
hidden, and one you open stays open next time.
2223

2324
When the workspace has the keyboard, it keeps it: <kbd>W</kbd><kbd>A</kbd><kbd>S</kbd><kbd>D</kbd> never fly the camera
2425
from here (see [Keys follow the panel you are in](controls.md#keys-follow-the-panel-you-are-in)). In the undocked

‎docs/connection.md‎

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,41 @@ It has two halves:
1313
- **📋 Your ID** — the button on the left shows your own peer ID. Click it to **copy your invite link** (your app URL with your ID attached, e.g. `https://theprototype.app/#AB12CD`) to the clipboard. Until the connection to the signaling server is ready it reads *Generating…*.
1414
- **Connect field** — paste a peer's ID into *Enter peer ID to connect* and press **Connect** to request a connection.
1515

16-
Since 1.30, once you are connected the bar **collapses to a compact chip** — a status dot, the session, the avatars
17-
of who is here and your mic; click it to open the full bar again (its collapse button folds it back). While the signaling link
18-
is down the status badge says how long it has been trying (*Reconnecting · 2 min*); the attempt count is in the drawer's
19-
**Info** tab. On a phone the bar is always the chip — tap it for your ID, the join field, Info and Toasts.
16+
Since 1.30, once you are connected the bar **collapses to a compact chip** — the status dot, the avatars of who is here
17+
and your mic; click it to open the full bar again (its collapse button folds it back). On a phone the bar is always the
18+
chip — tap it for your ID, the join field, Info and Toasts. The signaling link's attempt count is in the drawer's
19+
**Info** tab.
20+
21+
### The status dot
22+
23+
Since 1.32 the connection status is a **coloured dot**. On a computer the full bar keeps your invite ID and the peer-ID
24+
field, with the dot at its left end. On a phone the chip at the top of the screen says the state beside the dot —
25+
**Connected**, **Connecting…** or **Offline** — whenever the top bar has room. When the bar is crowded (people are
26+
connected and you are in a call, so the peers button and the microphone take the space) it shrinks back to the dot and
27+
a ▾ (and the microphone while you are in a call).
28+
29+
| Dot | Means |
30+
|---|---|
31+
| grey | not connected |
32+
| yellow, pulsing | connecting, waiting for someone to approve, or reconnecting to the peer server |
33+
| green | connected |
34+
| red | the peer server cannot be reached (the app keeps retrying) |
35+
36+
Point at the dot — or press and hold it on a touch screen — for the full sentence, such as *Connected to 2 peers*;
37+
while the signaling link is down it also says how long it has been trying. On a phone a tap on the chip opens the full
38+
connection details.
39+
40+
![The phone's top bar when it is crowded: the logo, the connection chip with a green dot, ▾ and the microphone, then the bell and the peers](img/connection/status-dot-phone.png){ width="420" }
41+
42+
### Who is here: the peers panel
43+
44+
The peers button in the top bar (beside the bell, with the number of people) opens the **Connected** panel. Its header
45+
matches the notification centre's, and each person is **one row**: their avatar, their name (shortened with … — point
46+
at it for the full name), a second line with where they are and their role, and their actions on the right — **Watch**,
47+
**Go to** or the role list. On a computer the panel is 320–420 px wide and grows with long names, so nothing wraps or
48+
breaks. On a phone it opens as a sheet like the notifications: a grab bar on top, and a swipe down closes it.
49+
50+
![The Connected panel on a computer: five people, one row each — avatar, name, the scene they are in and their p-number underneath, and Editor or Viewer with Go to or Watch on the right](img/connection/peers-panel-desktop.png){ width="515" }
2051

2152
### Inviting someone
2253

@@ -123,7 +154,7 @@ A momentary network blip no longer throws you out, either. A peer that drops for
123154

124155
## When the signaling link drops
125156

126-
The link to the signaling server is not the link to your peers — losing it does not end a session you are already in, it only stops new people finding you. When it drops the app reconnects on its own, backing off a little further between tries and **never giving up**, and the Connect pill carries a chip while it is retrying so a dead link does not read as a dead app. Coming back online, or returning to the tab, retries immediately instead of waiting out the backoff. A peer connection that closed is rebuilt rather than abandoned.
157+
The link to the signaling server is not the link to your peers — losing it does not end a session you are already in, it only stops new people finding you. When it drops the app reconnects on its own, backing off a little further between tries and **never giving up**, and the [status dot](#the-status-dot) pulses yellow while it is retrying so a dead link does not read as a dead app. Coming back online, or returning to the tab, retries immediately instead of waiting out the backoff — and since 1.32 it does so **silently**: switching apps on a phone and coming back no longer toasts. If the server stays unreachable for about a minute, the dot turns red and **one** entry appears in the notification centre; the retries carry on. A peer connection that closed is rebuilt rather than abandoned.
127158

128159
## Diagnostics you can copy
129160

@@ -172,5 +203,5 @@ It carries an **Open Settings** button that jumps straight to **Settings ▸ Con
172203
| *AB12 declined your connection request* | The host pressed **Reject**. Ask them before dialling again. |
173204
| *AB12's session is full (16 people)* | Everyone connects to everyone, so a session has a ceiling. Someone has to leave before another person can join — **Try again** on the toast re-asks. |
174205
| *Could not reach … — back on your previous peer server.* | **Apply** could not open the server you picked, so nothing changed — check the host, port and path. |
175-
| *Lost the peer server - reconnecting...* / *The peer server closed the link - reconnecting...* | The link to the signaling server dropped; the app retries on its own and never gives up. *Reconnected to the peer server.* confirms it is back. Your open session keeps going meanwhile. |
176-
| *Cannot reach the signaling server - the connection request was not sent.* | You pressed **Connect** while the signaling link is down. Wait for the reconnect chip to clear, or switch servers in Settings ▸ Connection. |
206+
| A **red** status dot, and one *Can't reach the peer server — still retrying.* entry in the notification centre | The link to the signaling server has been down for about a minute; the app keeps retrying on its own and never gives up, and the dot turns green or grey again once it is back. Shorter drops — a tab switch, a moment offline — reconnect silently. Your open session keeps going meanwhile. |
207+
| *Cannot reach the signaling server - the connection request was not sent.* | You pressed **Connect** while the signaling link is down. Wait for the status dot to stop pulsing, or switch servers in Settings ▸ Connection. |

0 commit comments

Comments
 (0)