# IGNCore

IGNcore is a performance oriented chatbot for the MMORPG Anarchy Online released by Funcom in 2001.

**If you're unsure about good ways of setting it up, this bot is NOT for you. 
The bot targets advanced use cases of bigger bots, and lacks all types of documentation as of now.**
## Requirements
IGNCore requires Python 3.9 or newer.

## Installation
IGNCore is recommended to use for large scaled bots, or bot networks consisting out of multiple bots. 

1) Download the Repository,
2) copy conf/config.py to conf/##botname##.py
3) add your database details to the config
4) copy the dummy.start.sh to a filename of your choice, and replace ##bot_name## with the name of your bot.
Note: the superadmin needs to be supplied in char_id format instead of a name.

regarding step 4: for module paths, you can choose between raidbot, orgbot and onlinebot [used for a centralized alliance bot] modules. 
Compatibility between these modules is **not** guaranteed.
## Upgrade

For upgrading just pull in the latest changes from the repository, and restart the bot.

## Starting the Bot

To start the bot, run the start file you created in step 4 of the installation.

## Support

If you need help or support with IGNCore, reach out to us by contacting us via gitlab Issues.

## Discord Module Setup

For setting up the discord module, create a discord bot, invite it into your server, and fill in the required details in !config mod core.discord.

- Library used: https://discordpy.readthedocs.io/en/latest/index.html.
- Official Discord API docs can be accessed here: https://discordapp.com/developers/docs/intro.
- Official Discord API server: https://discord.gg/discord-api.