Update docs and bump libraries #262
Conversation
server/readme.md
Outdated
|
|
||
| This can be changed by setting the environment variable `GLOBED_LOG_LEVEL` for the central server, or `GLOBED_GS_LOG_LEVEL` for the game server. The appropriate values are: `trace`, `debug`, `info`, `warn`, `error`, `none`. | ||
| In release builds, the default log levels are set to `Info`, `Warn`, and `Error`. To change the log level, set the environment variable `GLOBED_LOG_LEVEL` for the central server or `GLOBED_GS_LOG_LEVEL` for the game server. Possible values include: `trace`, `debug`, `info`, `warn`, `error`, `none`. |
There was a problem hiding this comment.
honestly i think this can be clarified better to say that the environment variable controls the minimum log level. i.e. setting it to trace will enable all logs, not just trace. not sure this is immediately clear from this wording
also the level names probably should have consistent capitalization :p
|
|
||
| Additionally, when first starting up a server, a `Rocket.toml` file will be created from a template. By default, it will be put in the current working directory, or `ROCKET_CONFIG` if specified. | ||
| When starting the server, a `Rocket.toml` file is generated, typically in the current working directory (or the directory specified by `ROCKET_CONFIG`). This file is used for configuring the HTTP port and database path, among other settings. Refer to [Rocket documentation](https://rocket.rs/guide/v0.5/configuration/#rocket-toml) for further configuration options. |
There was a problem hiding this comment.
or the directory specified by
ROCKET_CONFIG
not very accurate, directory might work as well but it's intended that ROCKET_CONFIG takes in a path to a file, not a directory
| There is also a special format for tinting colors, for example setting `name_color` to `#ff0000 > 00ff00 > 0000ff` would make your name fade between red, green and blue. Spaces and a `#` at the start are for clarity and are optional. (Maximum 8 colors supported in one string) | ||
| ### Special Role Tinting: | ||
|
|
||
| You can create color transitions for names by using a special format, e.g., setting `name_color` to `#ff0000 > 00ff00 > 0000ff` will make the name fade between red, green, and blue. |
There was a problem hiding this comment.
i think mentioning the 8 color limit is important here
server/readme.md
Outdated
| // all keys except id and priority are optional. | ||
|
|
||
| "id": "mod", | ||
| "priority": 100, // determines which roles can edit users with other roles | ||
| "badge_icon": "role-mod.png", // make sure it's a valid sprite! (can be empty) | ||
| "name_color": "#ff0000", // name color | ||
| "chat_color": "#ff0000", // color of chat messages | ||
|
|
||
| // permissions | ||
| "notices": false, // ability to send notices (popup messages) | ||
| "notices_to_everyone": false, // ability to send a notice to everyone on the server | ||
| "kick": false, // ability to disconnect users from the server | ||
| "kick_everyone": false, // ability to disconnect everyone from the server | ||
| "mute": false, // ability to mute/unmute | ||
| "ban": false, // ability to ban/unban & whitelist (on whitelist enabled servers) | ||
| "edit_role": false, // ability to change roles of a user | ||
| "edit_featured_levels": false, // ability to edit featured levels | ||
| "admin": false, // implicitly enables all other permissions and also does some additional things | ||
| "priority": 100, | ||
| "badge_icon": "role-mod.png", | ||
| "name_color": "#ff0000", | ||
| "chat_color": "#ff0000", | ||
| "notices": false, | ||
| "notices_to_everyone": false, | ||
| "kick": false, | ||
| "kick_everyone": false, | ||
| "mute": false, | ||
| "ban": false, | ||
| "edit_role": false, | ||
| "edit_featured_levels": false, | ||
| "admin": false |
There was a problem hiding this comment.
i don't really like this reformatting nor removal of comments, i feel like some of the settings aren't immediately clear from the name (nor is the fact that most are optional)
There was a problem hiding this comment.
i thought its understable by var names
| | `use_gd_api` | `false` | Verify account ownership via GD servers (requires `gd_api_account` and `gd_api_gjp`) | | ||
| | `gd_api_account` | `0` | Bot account ID for verification | | ||
| | `gd_api_gjp` | `(empty)` | GJP2 for account verification | | ||
| | `gd_api_url` | `(...)` | Base URL for GD API used for account verification | |
There was a problem hiding this comment.
feel like mentioning the expected format is important here, i.e. someone might put just https://www.boomlings.com (without /database) and that won't work
There was a problem hiding this comment.
do u mean like setting its default to "https://www.boomlings.com/database/" or something like that?
changelog.md
Outdated
There was a problem hiding this comment.
i'm not sure i'm a big fan of this, changelog is intentionally verbose and lists almost every change in the update (that is visible to the user of course)
finally doneeeeee