/TalosBot

A chatbot that works on Chatzy and Discord

Primary LanguagePythonMIT LicenseMIT

Talos

Build Status

A writing utility chatbot with releases for both Discord and Chatzy (an online chat room service). Its primary mission is to provide useful utility-type commands to assist writers.

The Chatzy release is JavaScript-based, and runs in a browser tab. The discord release is python, running on python version of at least 3.6.

How to invite

Talos for Discord is hosted and run through google cloud, with a consistent 99.9% uptime. To invite Talos into your own server, simply follow this link:

Talos Invite

More information on Talos can be found at the official site, talosbot.org

How to Run

If you wish to run this bot for yourself, here's how.

Chatzy

First, a warning: Chatzy ToS states: "User scripts designed specifically to modify the behavior of Chatzy are not permitted."
Before you try running this bot yourself, make sure that you have received permission from Chatzy to do so on the room that you plan to run it in, as the developers of this bot are not responsible for any actions of Chatzy in response to your use.

  1. Open up a new Chatzy tab, and log into the room you wish to run in. Make sure that timestamps are enabled in the room. The bot will not run without this setting being enabled. The setting can be changed by a room admin with the 'Room Properties' menu.

  2. Open the console and paste in the code from the 'chatzy\TalosStart.js' file. Hit 'enter'. If prompted, allow popups- the window is the log4js console.

    • If you were prompted to allow popups, after doing so you may want to refresh and repeat step 2 so the log4js console actually opens.

  3. Talos should now be running in that tab. Feel free to navigate away, try to avoid clicking on things on the page as it may confuse Talos.

Discord

  1. You will need to clone this repository onto your computer. You can do this through the command line with git clone http://github.com/CraftSpider/TalosBot/

  2. Navigate into the TalosBot\ directory

  3. Install the discord.py library, the google API library, the mysql connector, and the pillow library using the command python3 -m pip install -r requirements.txt

  4. Run the command python3 runner.py discord to generate the Talos token file.

  5. Place your token in "token" key in token.json, and fill in any other tokens you may wish to use. For example, to have Talos use a database connection, put the connection info under "sql".

  6. Run the command python3 runner.py discord again. Talos should now be running.

  7. If you are running Talos with a database connected, give it the ^verifysql command and it will build its own database schema.