Skip to content

Client‐making guidelines

nin0dev edited this page Oct 21, 2024 · 1 revision

You aren't required to follow these, but doing so is strongly recommended and required if you want your client to be recommended.

Roles

For people with a guest role, clearly label it with a grey guest tag.

For people with a mod role, make their name green and give them a green mod tag.

For people with the admin role, make their name red and give them a red admin tag.

For bots, make their name blue and give them a blue bot tag.

Authentication

You can use the POST /api/auth/login endpoint on https://chatapi.nin0.dev while passing a JSON body containing an email and password field. If everything goes well, you'll receive the token.

Avoid implementing signup.

System messages

Hide their username, and give them a special background or italicize them.

Chat restrictions

Guests can't send links or over 300 characters. Regular users can send maximum 1000 characters.

Errors

Errors should be temporary and not shown in the message UI unless absolutely needed.

Clone this wiki locally