README.md

Ngoto

Warning ⚠️

This tool is solely for educational purposes. Developer will not be responsible for any misuse of the tool

Example:

1. Install Module

Using pip or pip3, install the 'ngoto' module.

pip install ngoto

2. Example Code

The following code is a example on how to create each of three event types, as well as start the tool.

from ngoto import plugin, command, task, Ngoto


class Basic():
    @plugin(name='Tester', desc='Tester Plugin', folder='Random')
    def tester(self, logger):
        logger.info(f'Plugin ran', program='Test')

    @command(name='test', aliases=['t'], desc='Tests command')
    def test(self, logger, options):
        logger.info(f'Command ran', program='Test')

    @task(name='TaskTest', desc="Tests task creation", delay=3, id='test')
    def testing(self):
        self.logger.info(f'Task logger test ran', program='Test')
        return 'Task ran'


ngoto = Ngoto()
ngoto.load_cogs([Basic()])
ngoto.start()

Development

1. Clone Repo:

git clone https://github.com/HarryLudemann/Ngoto

2. Install Required Modules:

Move into downloaded Ngoto folder then pip/pip3 install requirements:

pip install -r requirements.txt

3. Run

Start script by running python/python3 main.py script:

python main.py

Which will bring you to the following: