generator

Documentation

Overview

generator generates packet structs and methods based on the packets.txt file.

packets.txt structure:

• A packet is separated by another with a line of 4 more dashes.
• The first line of a package declaration must have the Packet ID and the name, like this: ID: 0, Name: OsuSendUserStatus
• The next lines before the structure declaration are considered as the description of the packet, and will be written in the final go file as the documentation of the struct.
• The following lines must contain the structure of the Packet, in the following format (description is within brackets because optional):
• StructField Type[, Description]

For instance:

ID: 24, Name: BanchoAnnounce

BanchoAnnounce is sent by bancho to notify the osu! clients of something.

- Message string