OptimisticDev/rfcs
2
1
Fork 0
forked from kaboom-standards-organization/rfcs
Code Pull requests Activity

RFC 0001: Add guide target section

Browse source
This commit is contained in:
OptimisticDev 2024-06-26 04:32:29 +00:00
parent 9d6a758744
commit 1ffd52a4b1
Signed by: OptimisticDev
SSH key fingerprint: SHA256:efAXeDMyuFt1iia2xaqlrcHPlsXcjQEWNA2tmvVTqK8
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
rfcs/0001-Code_Guides.md
View file

@ -50,6 +50,30 @@ If there is a newer version available for the library than the documentation is
If there is not a new version available for the library than the documentation is written for, and the server version is above the protocol version the latest version of the library targets, a suffix must not be appended if the library is maintained. If the library is no longer maintained, an `(UNMAINTAINED)` tag should be added to the documentation title. No more updates to documentation for unmaintained libraries is expected from contributors, however you are welcome to add it. If there is not a new version available for the library than the documentation is written for, and the server version is above the protocol version the latest version of the library targets, a suffix must not be appended if the library is maintained. If the library is no longer maintained, an `(UNMAINTAINED)` tag should be added to the documentation title. No more updates to documentation for unmaintained libraries is expected from contributors, however you are welcome to add it.
### Guide Targets
Guides must attempt to illustrate, at the bare minimum:
1. How to get a bot to connect to the server, and send a chat message of "Hello world!", without the quotes, on login
2. How to get a bot to parse system chat and output, without color codes, to stdout
3. How to get a bot to listen for player chat messages, and check their content for a specific keyword and then reply to it.
Guides should also attempt to tackle:
1. Registry-based profileless/player chat packet parsing
2. ANSI log output and color code parsing
3. Implementing a command queue
4. Implementing a chat queue
5. Tracking rectifiable property states (i.e. OP and gamemode)
6. Correcting rectifiable property states with queue-skipping command execution
Guides should offer the reader tips on how to:
1. Parse chunks
2. Maintain command cores
3. Rectify properties silently
4. Not lag the server
## Common Ground ## Common Ground
Guides are likely to have some sort of common ground. Guides are likely to have some sort of common ground.