Skip to content

Instantly share code, notes, and snippets.

@PEMapModder
Created September 17, 2015 15:28
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save PEMapModder/a31f2a62108da934f951 to your computer and use it in GitHub Desktop.
Save PEMapModder/a31f2a62108da934f951 to your computer and use it in GitHub Desktop.
# RedstoneLamp Protocol Documentation File
# In this way you can make comments with the # sign
# Just indent this file in any sizes and we still accept it!
# Note that you may not use # as the comment sign at the middle of a line!
ProtocolName Minecraft NokiaEdition V01
# ProtocolName <protocol name ...>
ProtocolDescription this is an example protocol.\
In this way you can\
spread your line into multiple lines.\
And it can be \
of any number of spaces!
# ProtocolDescription <description ...>
# ProtocolDescription is optional and default to "(no description)"
DefaultRequestPackage net.redstonelamp.request
# DefaultRequestPackage <package name>
DefaultResponsePackage net.redstonelamp.response
# DefaultResponsePackage <package name>
# DefaultRequestPackage and DefaultResponsePackage are optional and default to the values above.
DeclarePacket 01
# DeclarePacket <hex packet ID>
PacketName ChatPacket
# PacketName <packet name>
AssocRequest ChatRequest
# AssocRequest <associated Request class name, may be relative to DefaultRequestPackage>
PacketField STRING message
# PacketField BYTE|SHORT|TRIAD|BE_TRIAD|BIG_ENDIAN_TRIAD|LTRIAD|L_TRIAD|LE_TRIAD|LITTLE_ENDIAN_TRIAD|INT|INTEGER|LONG|VAR_INT|VARINT|STRING|VAR_STRING|VARSTRING|FLOAT|DOUBLE|UUID|BOOLEAN|ADDRESS|METADATA [-unsigned] <field name at the request/response class> [<comments ...>]
# OR
# PacketField SKIP <bytes to skip> [<comments ...>]
PacketField SHORT -unsigned wordsCount
PacketField SKIP 4 here are four bytes that don't exist in the request class
CommitRequest
AssocResponse ChatResponse
# AssocResponse <name of the Response class to associate to, may be relative to DefaultResponsePackage>
PacketField STRING message
packetField BYTE position
CommitResponse
CommitPacket
# CommitPacket
# You must commit a packet before declaring another one
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment