Creating An Issue

Issue Naming Scheme Convention

There are three types of issues you can create relating to unimplemented features:

All of these are generally printed in yellow on the console.

Protocols

These are sent from the MessagePump via the NetworkLogger, and will look as follows:

When creating your issue, it should title with PROTOCOL: [PROTOCOL NAME] - [WHAT YOU THINK THE PROTOCOL DOES]. In the description of the issue, you should attach a screenshot of the protocol (like shown above), followed by a brief description of what you did to invoke this.

With this, the protocol name is dg, as follows after Unhandled packet.

Web Requests

These are sent from the RequestLogger, and will begin with 404, as well as the URL it is trying to connect to and looks as follows:

When creating your issue, it should title with WEB: [SHORTENED WEB URL] - [WHAT YOU THINK THE WEB REQUEST DOES]. In the description of the issue, you should attach a screenshot of the web request (like shown above, including the purple TRACE message before it), followed by a brief description of what you did to invoke this. The shortened URL should include the first 1-2 components, followed by ..., and the last component of the URL.

For example, I may put the shortened URL as Chat/.../PhraseCheck, as it gives enough information to understand what this function does, whilst still keeping it brief.

Entities

These are sent from the SyncEvent via the NetworkLogger, and will look as follows:

When creating your issue, it should title with ENTITY: [ENTITY TYPE] - [SYNC EVENT TYPE]. In the description of the issue, you should attach a screenshot of the entity request (like shown above, including the blue TRACE message after it), followed by a brief description of what you did to invoke this.

For example, in the message above, TriggerReceiver is the ENTITY TYPE, and Trigger is the SYNC EVENT TYPE.

You should be creating an issue for each entity type. If there are multiple, include the most relevant.

Bugs

If you encounter any weird functionality with none of the above messages popping up, please label it as BUG: xxx, where xxx is a brief title of the issue. Please ensure that it would not have happened in the original game as well, as we aim to preserve these.