New readme, docs, infra for devs #1558
Conversation
(The markdown preview system I'm using seems to be lying to me, so I want to see what this looks like with gfm for one commit).
README.md
Outdated
|
|
||
| 1. Look at the server console for the _auth code_. Type `/auth [code]` (example: `/auth 12345`), then a space, then the code you see in the console in your game chat. Instead of chatting, you'll run a command on the server. This one makes you temporary admin. All commands are prefixed with `/` or `!` (to make them silent). | ||
|
|
||
| 1. Use the in-game command `/register [password]` (example: `/register lovely-ashes`) to create an account. This gives you owner rights on your server, which you can configure more to your liking later. Your `character name` is your `account name`. |
There was a problem hiding this comment.
Examples should be consistent.
Either
/register ashes
/login shank ashes
or
/register lovely-ashes
/login shank lovely-ashes
There was a problem hiding this comment.
Your
character nameis youraccount name
Login to your newly created account with/login [username] [password]
Consistency would make this clearer:
Your
character nameis youraccount name
Login to your newly created account with/login [account name] [password]
or
Your
character nameis yourusername
Login to your newly created account with/login [username] [password]
There was a problem hiding this comment.
Since we're moving away from user, I've changed this to account name.
README.md
Outdated
|
|
||
| 1. Login to your newly created account with `/login [username] [password]` (example: `/login shank ashes`). You should see a login success message. | ||
|
|
||
| 1. Turn off the backdoor with `/auth-verify` and your server is setup for initial use. TShock also created several files inside a new `tshock` folder. These files include `config.json` (our big configuration file), `sscconfig.json` (the server side characters configuration file), and `tshock.sqlite`. Don't lose your `tshock.sqlite` or you'll have to re-setup TShock all over again. |
There was a problem hiding this comment.
Turn off the backdoor
Consider revising to "Turn off the auth system"... Mentioning backdoors is never a good idea.
[...]re-setup TShock all over again
re- implies repeating, so revise to
re-setup TShock
or
setup TShock all over again
There was a problem hiding this comment.
To be fair, the 'auth system' being turned off is not what we want to convey either. That's really bad language.
There was a problem hiding this comment.
"Complete first-time account setup by running ...." perhaps
hakusaro
changed the title
|
Ready for review, @Pryaxis/tshock! ✨ |
|
This bullet:
I don't think I can do right now. Too much is shifting around with Bouncer to do an accurate summation of what TShock intends to provide long-term support wise to plugins. Now isn't the time to make promises we can't keep. |
This is the WIP branch for my initiative to revamp:
Please give feedback on my copy and what needs to be improved or changed. I'm trying to make it look top notch 👌🏻
(Fixes #1531.)