Skip to content

Commit 0459d64

Browse files
author
Nathaniel Smith
committed
document flow for new users
1 parent 9c42ca3 commit 0459d64

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

new.user.flow.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Workflow for new users
2+
3+
_no credentials present (cookie or localstorage):_
4+
5+
1. Prompt for new player information
6+
7+
> Hello! blah blah, make a new character with the (new-player) function like so:
8+
> (new-player :name "Joe" :password "FooBar" :desc "Just a random person")
9+
10+
11. User runs new-player
11+
12+
2. Generate uuid for auth details
13+
14+
3. Store auth credentials in localStorage: {"name":"...",
15+
"password":"...", "desc":"...", "uuid": "..."}
16+
17+
4. *Any API request uses a make-api function that signs everything
18+
with the auth object.*
19+
20+
5. Backend will create user objects for new uuids.
21+
22+
6. Put player (in room 0)
23+
24+
/new-player
25+
body: auth details
26+
27+
7. Tell user
28+
29+
> You find yourself in a windowless room.
30+
31+

0 commit comments

Comments
 (0)