User talk:Rain/Sandbox: Difference between revisions
(Created page with "*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, file permissions, specific features of tools/libraries, do not belong on this page. Users are expected to have a certain brain capacity to be able to google f...") |
No edit summary |
||
| Line 1: | Line 1: | ||
'''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 describes in detail how an aspect of the implementation of Pavlov VR RCON works, it belongs on this page. | ||
| Line 7: | Line 7: | ||
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. | 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. | The user/reader is never to be referred to directly. Reflexive and personal pronouns are to be avoided. | ||
| Line 30: | Line 30: | ||
'''TODO''' | |||
- Gamemodes table, which was moved to dedicated server Game.ini configuration, should be integrated into Gamemodes page | - Gamemodes table, which was moved to dedicated server Game.ini configuration, should be integrated into Gamemodes page | ||
Revision as of 07:59, 23 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, file permissions, specific features of tools/libraries, do 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.
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
- Gamemodes table, which was moved to dedicated server Game.ini configuration, should be integrated into Gamemodes page - Disconnect command states "This should always be used when done" but I doubt this is an actual requirement. Needs clarification from dev and, if not strictly required, should be removed. - GiveAll fails to execute, requires testing by more people than just me - Test and specify GiveItem slot behaviour for each item category - 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 - TTTFlushKarma shows no parameters in Help, but is expected to require a parameter (previous wiki, also logically). Confirm it takes one [UniqueID] parameter and send bug report to dave - TTTGiveCredits - is credits and cash not the same? clarify. does tttgivecredits and givecash/setcash do different things? - TTTSetRole was previously marked as "currently broken" - requires testing if still broken or if it works now. also link to itemids#ttt-roles - telnet doesn't seem to work - see discord#rcon-overview-and-commands - difference to shack servers (shack Help output required) - see discord#rcon-overview-and-commands