Talk:Rcon Overview and Commands: Difference between revisions
(→Work in progress: new section) |
No edit summary |
||
| Line 1: | Line 1: | ||
== | ==What does and does not belong on this page== | ||
This | If something describes in detail how an aspect of the implementation of Pavlov VR RCON works, it belongs on this page. | ||
If something is only tangentially related to RCON, like how to get an MD5 checksum from text, how to use bash to pipe a list of commands into netcat, port forwarding, file permissions, specific features of tools/libraries, do not belong on this page. | |||
If something is a hack and not officially supported, such as having more than 10 max players on shack servers, does not belong on this page. | |||
Users are expected to have a certain brain capacity to be able to google for things to figure them out. This is not an IT help forum that explains in detail how to use computers. All it must contain is information specific to the RCON protocol. Exception, of course, are the list of available RCON tools and libraries, but this must be limited to a list and a very short description only. | |||
==Grammar and syntax== | |||
The user/reader is never to be referred to directly. Reflexive and personal pronouns are to be avoided. | |||
Bad: You can run the command. | |||
Good: This command can be run. | |||
Bad: If this does not work, try something else. | |||
Good: There are alternatives, should this not work. | |||
Bad: Note: I don't think this is accurate | |||
Good: Note: The accuracy of this information may be questionable. | |||
Command descriptions use the imperative third person form. These sentences are formulated by starting with "This command...". | |||
Bad: Ban a player | |||
Good: Bans a player | |||
Bad: To enable or disable the whitelist | |||
Good: Enables or disables the whitelist | |||
==TODO== | |||
* GiveAll fails to execute, requires testing by more people than just me | |||
* accurate GiveItem chest slot count required | |||
* SetPlayerSkin, are there any other conditions where skin is removed (eg. TTT new round/role, switching sides in push, ...) | |||
* SetTimeLimit fails to execute, requires testing by more people than just me | |||
* difference to shack servers (shack Help output required) - see discord#rcon-overview-and-commands | |||
Latest revision as of 06:02, 30 June 2023
What does and does not belong on this page
If something describes in detail how an aspect of the implementation of Pavlov VR RCON works, it belongs on this page.
If something is only tangentially related to RCON, like how to get an MD5 checksum from text, how to use bash to pipe a list of commands into netcat, port forwarding, file permissions, specific features of tools/libraries, do not belong on this page.
If something is a hack and not officially supported, such as having more than 10 max players on shack servers, does not belong on this page.
Users are expected to have a certain brain capacity to be able to google for things to figure them out. This is not an IT help forum that explains in detail how to use computers. All it must contain is information specific to the RCON protocol. Exception, of course, are the list of available RCON tools and libraries, but this must be limited to a list and a very short description only.
Grammar and syntax
The user/reader is never to be referred to directly. Reflexive and personal pronouns are to be avoided.
Bad: You can run the command.
Good: This command can be run.
Bad: If this does not work, try something else.
Good: There are alternatives, should this not work.
Bad: Note: I don't think this is accurate
Good: Note: The accuracy of this information may be questionable.
Command descriptions use the imperative third person form. These sentences are formulated by starting with "This command...".
Bad: Ban a player
Good: Bans a player
Bad: To enable or disable the whitelist
Good: Enables or disables the whitelist
TODO
- GiveAll fails to execute, requires testing by more people than just me
- accurate GiveItem chest slot count required
- SetPlayerSkin, are there any other conditions where skin is removed (eg. TTT new round/role, switching sides in push, ...)
- SetTimeLimit fails to execute, requires testing by more people than just me
- difference to shack servers (shack Help output required) - see discord#rcon-overview-and-commands