package
0.3.5
Repository: https://github.com/ankurkotwal/metarefcard.git
Documentation: pkg.go.dev

# Functions

FilterDevices - Returns only the devices that the caller is asking for.
GameBindsAsString returns the object as a printable string.
GenerateContextColours - basic utility function to generate colours.
GenerateImageOverlays - creates the image overlays into overlaysByImage.
GenerateImages returns the generated images.
LoadDevicesInfo loads all the device information (across files) into "devices".
LoadGameModel - load game specific data from our model.
LoadYaml loads Yaml file and prints any errors.
NewLog creates a new logger.
PopulateImageOverlays returns a list of image overlays to put on device images.
YamlObjectAsString outputs contents of yaml object with a label.

# Constants

DeviceMissingInfo - only know the name of device.
DeviceUnknown - unfamiliar with this device.
InputPrimary - primary input.
InputSecondary - secondary input.
NumInputs - number of inputs.
ProfileDefault - the name of the default profile.

# Structs

Config contains all the configuration data for the app.
Devices holds all the device related data.
Dimensions2d contains width and height.
GameData holds the game's parsed data.
GeneratedDevices holds structure from the generated config.
HeaderData contains necessary data to generate header.
InputData - data relating to a given input.
LogEntry contains the message and metadata.
OverlayData - data about what to put in overlay, grouping and location.
Point2d contains x and y.
WatermarkData contains necessary data to generate watermark.

# Type aliases

ContextToColours is a mapping of game contexts to colours that are used for visual grouping.
DeviceInputs - structure of inputs for a device.
DeviceInputTypeMapping contains a map of device short names to types of input maps (e.g.
DeviceMap - structure of devices.
DeviceNameFullToShort maps game device full names to MetaRefCard short names.
FuncMatchGameInputToModel takes the game provided bindings with the device map to build a list of image overlays.
FuncRequestHandler - handles incoming requests and returns game data, game binds, neededDevices and a context to colour mapping.
GameActions - Action -> Input.
GameBindsByProfile - Profile -> Short name -> Context -> Action -> Primary/Secondary -> Key.
GameContextActions - Context -> Action.
GameDeviceContextActions - Short name -> Context -> Action -> Primary/Secondary -> Key.
GameInput - Array of inputs.
ImageMap - contains device short name -> image name.
InputTypeMapping maps the type of input (e.g Slider, Axis, Rotation) to a map of game input to MetaRefCard input (e.g.
Logger is a log utility to log to.
OverlaysByImage - image overlay data indexed by image name Image -> Device:Input -> OverlayData.
OverlaysByProfile - image overlay object indexed by profile Profile -> OverlaysByImage.
RegexByName - map of named regex strings.
Set is a map masquerading as a set.