Basic structure

A module is just a table, with metadata and an init function.

Metadata

id - The id of the module, used for collision checking.
name - The name of the module, used in the error message.
author - The name of the author of the module, not the contact info.
contact - The contact info, used for the error message. It can be anything, though you should prefer a link to your issue tracker.
report_msg - The error message to display, you can use the module info by prefixing it with __.

Init signature

Arguments:

box - The pixelbox object, returned from :new.
module - Your module metadata, like id and name.
api - The pixelbox module, which contains the internals.
share - A table shared between all modules.
initialized? - Whether or not pixelbox generated the lookups.
- "you could for example modify the sampling_lookup to lower the teletext char artifacting for a specific usecase (like a graph or something idk)"
- - devvie (i have no clue about what that shit means)
load_flags - Things passed into the modules table when loading them.

Return values:

values - Values inserted into the pixelbox object.
- Note, however, that you cannot replace values that are already in the box, except functions.
callbacks - refer to the callbacks section.

Callbacks

`verified_load`

This is called when pixelbox is done initializing modules.

It takes no arguments, and is not expected to return anything.

Pixelbox api

`module_error`

This function throws a fancy error, formatted by pixelbox.

Arguments:

module - Your module information, use the argument passed to init.
str - Error string, passed to error.
level - Erorr level, passed to error.
supress_error - Whether to actually throw the error... wuh??

Written by @viw-ty

mention/email me if this is outdated/wrong