Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 3.4 KB

docs.md

File metadata and controls

85 lines (52 loc) · 3.4 KB

Harmonial - Discord Bot Creator

Harmonial is a Python 3.5+ module that allows for the simple creation of Python Discord bots. Harmonial focuses to be easy to use with a vast array of functions at the users' disposal.

Documentation

Classes

harmonial.Function(function_type, params=None)

A Function class, which defines a bot function.

Parameters:

  • function_type (str) - The type of function that this class should be. A list of function_types can be found at the bottom of the documentation.
  • params - The parameters that the function should have. Different function_types will require different variable types.

harmonial.Event(event, functions)

An Event class, which defines a bot event.

Parameters:

  • event (str) - The type of event that will activate the functions functions.
  • functions (list[harmonial.Function]) - A list of Functions that will be activated, in order, upon the event's activation.

harmonial.Command(commandname, functions)

A Command class, which defines a bot command.

Parameters:

  • commandname (str) - The name of the command. This will be used to activate the functions by means of chat.
  • functions (list[harmonial.Function]) - A list of Functions that will be activated, in order, upon the command's activation.

Functions

harmonial.special(special_type, params=None)

A function that returns data based on the special_type and params provided.

Parameters:

  • special_type (str) - A string that defines which function should be executed.
  • params - Parameters for the function.

harmonial.build(filename, prefix, commands)

A function that compiles the list of Commands, commands, into finalized code. Note: after compilation, you will need to supply a bot token in the generated file.

Parameters:

  • filename (str) - File path that the final bot code will be written to.
  • prefix (str) - Prefix for the commands.
  • commands (list[harmonial.Command]) - A list of commands that will be in the bot.

Function Types

function_type:

  • 'say' (params as str) - Say a string params in the channel as a response.
  • 'writeFile' (params as tuple) - Write a string params[1] to file path params[0].
  • 'uploadFile' (params as str or file object) - Upload a file params to the channel as a response.
  • 'define' (params as tuple(str, *)) - Define a variable name params[0] with data params[1].
  • 'raw' (params as str) - Add a line of raw Python code.

special_type:

  • 'randomNumber' (params as tuple(int, int )) - Returns string combiner that will return a random number between the range as defined in the tuple.
  • 'contentsOf' (params as str) - Returns the contents of a file at path params.
  • 'variableString' (params as str) - Returns a string combiner that will return the result of a variable params in string form.
  • 'rawVariable' (params as str) - Returns the raw contents of a variable params.

Miscellaneous Info

  • When '$argument' is used in a function inside of a Command, it will return the contents after the command.
  • When '$+' is used in harmonial.special() with a special_type of 'define', numbers that come after the flag will be appended onto the variable (ex. '$+142' will add 142 to the variable).