meta.folder structure

Warning

This page is very outdated and is missing critical information. Take everything on here with a grain of salt.

This is our current directory structure and what each directory is for. This structure should not be changed without consulting the team first.

• src
  • main - root of all Java files
    • inputs - dir where all Inputs should live
      • YOUR_INPUT_NAME - dir where all the stuff for this input should live; name can be freely chosen
        • NAME_YOUR_INPUT.java - name can be freely chosen
    • modules - dir where all Hooks should live
      • core - contains the functionality that is included in the bot by default, strictly speaking all of this is optional, meaning the bot wont crash, without some of it, the Bot will not work as expected.
      • YOUR_MODULE_NAME - your custom Modules, a Module is a collection of Hooks; name can be freely chosen
        • YOUR_HOOKS.java - name can be freely chosen
    • system - core system files needed for running the Bot, like Hook and Subscriber Runner
  • ressources - Spring Boot resources, mainly configs
  • test - test root, should mirror structure of main dir

The systems folder contains all the basic stuff to keep the bot running, it is in some sense the framework for the rest of the Bot. This includes the Subscriber and Hook Runner, Hook Parser, Event-, Inputsystem and start & shutdown logic.