Base System Documentation

Info

Structure of this document

This page will contain documentation for inter-unit communication of the base code system. First it will contain data for the modules found in the lib folder. There will be a header for each file followed by sub-headers for inward travelling data and outward traveling data.

Modules

ai.py

In:

1. addcom
   • Basic syntax is as follows:
     • ['channelName', 'activatingUser', time, 'addcom [args]']
   • '-cmd:' specifies the phrase to call a command.
   • '-response:' specifies the specific response.
   • '-level:' specifies which group of users can use it of [Everyone, Moderators, Owner].
   • '-active:' specifies if the command should become active as it is created.
   • '-linelim:' specifies the number of lines a command must wait before being used again.
   • '-timelim:' specifies the amount of time a command must wait before being used again.
   • '-users:' specifies either individual users or group names that have special access to the command, otherwise all within main group.
   • '-globallim:' specifies if the limits used should be global or within each main group.
   • Currently unused markers: conditions, access
2. delcom
   • Basic syntax is as follows:
     • ['channelName', 'activatingUser', time, 'delcom [args]']
   • '-cmd:' specifies the command phrase to be deleted.
3. addtimer
   • Basic syntax is as follows:
     • ['channelName', 'activatingUser', time, 'addtimer [args]']
   • '-cmd:' specifies the phrase for the timed message to output.
   • '-hours:' specifies how many hours between activation.
   • '-minutes:' specifies how many minutes between activation.
   • '-seconds:' specifies how many seconds between activation.
   • '-name:' specifies the internal unique name of the timer.
   • '-active:' specifies if the timer is activated during creation.
4. deltimer
   • Basic syntax is as follows:
     • ['channelName', 'activatingUser', time, 'deltimer TIMERNAME']
   • 'TIMERNAME' is the internal name of the timer.
5. !addquote
   • Basic syntax is as follows:
     • ['channelName', 'activatingUser', time, '!addquote QUOTEVALUE']
   • 'QUOTEVALUE' is the string to be added to the quote dictionary.
6. !delquote
   • Basic syntax is as follow:
     • ['channelName', 'activatingUser', time, '!delquote QUOTEVALUE']
   • 'QUOTEVALUE' is the quote string as stored in the quote dictionary.

application.py

In:

assetloader.py

In:

Out:

configloader.py

In:

Out:

data.py

In:

Out:

initialize.py

In:

Out:

interface.py

In:

Out:

irc.py

In:

Out:

logger.py

In:

Out:

main.py

In:

Out:

network.py

In:

Out:

obs.py

In:

Out:

player.py

In:

Out:

setup.py

In:

Out:

shutdown.py

In:

Out:

splash.py

In:

Out:

streamer.py

In:

Out:

validator.py

In:

Out:

voice.py

In:

Out:

web.py

In:

Out:

webserver.py

In:

Out: