README
¶
GoGoGameBot
GoGoGameBot is a go reimplementation of my python GameBot. Both are designed to allow administration of game servers over chat platforms in a highly customisable manner.
Config
Config docs are a work in progress.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
command
Package command holds all of the tools for GGGB's command handling.
|
Package command holds all of the tools for GGGB's command handling. |
|
config/tomlconf
Package tomlconf is an implementation of GGGBs config system that works with a toml library rather than XML.
|
Package tomlconf is an implementation of GGGBs config system that works with a toml library rather than XML. |
|
game
Package game holds all of the code required to manage games
|
Package game holds all of the code required to manage games |
|
interfaces
Package interfaces holds interfaces used all over GGGB It exists as its own package to prevent cyclic import issues and simply because its cleaner Package interfaces ...
|
Package interfaces holds interfaces used all over GGGB It exists as its own package to prevent cyclic import issues and simply because its cleaner Package interfaces ... |
|
irc
Package irc contains a Bot implementation that works over the IRC protocol
|
Package irc contains a Bot implementation that works over the IRC protocol |
|
irc/ctcp
Package ctcp implements helpers for IRC Client-To-Client messages
|
Package ctcp implements helpers for IRC Client-To-Client messages |
|
nullconn
Package nullconn holds a null connection that satisfies interfaces.Bot
|
Package nullconn holds a null connection that satisfies interfaces.Bot |
|
process
Package process holds process management code for direct interaction with processes
|
Package process holds process management code for direct interaction with processes |
|
transport
Package transport provides an interface that allows for generic transport layers between gggb and a process
|
Package transport provides an interface that allows for generic transport layers between gggb and a process |
|
transport/network
Package network implements a Transport that works over a socket.
|
Package network implements a Transport that works over a socket. |
|
transport/network/prog
Prog is the clientside component of networkTransport.
|
Prog is the clientside component of networkTransport. |
|
transport/network/protocol
Package protocol holds structs and other constructs that are used by the network transport for cross-network RPC calls
|
Package protocol holds structs and other constructs that are used by the network transport for cross-network RPC calls |
|
transport/process
Package process holds a Transport implementation that runs local, unsandboxed processes
|
Package process holds a Transport implementation that runs local, unsandboxed processes |
|
transport/util
Package util contains utilities for use in all transport implementations
|
Package util contains utilities for use in all transport implementations |
|
version
Package version just holds the current version of the bot, for use in various files
|
Package version just holds the current version of the bot, for use in various files |
|
pkg
|
|
|
event
Package event contains an implementation of an event bus
|
Package event contains an implementation of an event bus |
|
format
Package format contains various formatting tools wrapped around text/template
|
Package format contains various formatting tools wrapped around text/template |
|
format/transformer
Package transformer implements a platform agnostic way of converting between platform specific formatting styles In order to do this, an intermediate format is used internally and by all implementations of Transformer The format is defined as follows Formatters are first indicated with a sentinel, '$', after which a single character for type follows The only defined types are: b Bold i Italics u Underline s Strikethrough r Reset $ Escaped Sentinel c Colour Colour has a special definition, instead of simply $c, the sentinel and type is followed by six hex characters that together indicate a colour.
|
Package transformer implements a platform agnostic way of converting between platform specific formatting styles In order to do this, an intermediate format is used internally and by all implementations of Transformer The format is defined as follows Formatters are first indicated with a sentinel, '$', after which a single character for type follows The only defined types are: b Bold i Italics u Underline s Strikethrough r Reset $ Escaped Sentinel c Colour Colour has a special definition, instead of simply $c, the sentinel and type is followed by six hex characters that together indicate a colour. |
|
format/transformer/minecraft
Package minecraft contains a Transformer implementation for the JSON specification of minecraft format strings see https://minecraft.gamepedia.com/Raw_JSON_text_format for a full look at the format itself
|
Package minecraft contains a Transformer implementation for the JSON specification of minecraft format strings see https://minecraft.gamepedia.com/Raw_JSON_text_format for a full look at the format itself |
|
format/transformer/simple
Package simple implements a Transformer that supports basic replacement based transformations
|
Package simple implements a Transformer that supports basic replacement based transformations |
|
format/transformer/tokeniser
Package tokeniser implements a tokeniser for the format/transformer intermediate language
|
Package tokeniser implements a tokeniser for the format/transformer intermediate language |
|
keepalive
Package keepalive contains various strings to use for keepalives.
|
Package keepalive contains various strings to use for keepalives. |
|
log
Package log provides a level based logger in place of go's standard logger
|
Package log provides a level based logger in place of go's standard logger |
|
util
Package util holds various utilities used all over gggb
|
Package util holds various utilities used all over gggb |
|
util/systemstats
Package systemstats holds code to query the status of the current system
|
Package systemstats holds code to query the status of the current system |
Click to show internal directories.
Click to hide internal directories.