Giter VIP home page Giter VIP logo

the-moth's Introduction

the-moth

Official bot of Satyrine's finest eatery... The Magniloquent Moth!

Check us out at: https://themagniloquentmoth.blogspot.com

Features:

  • supports slash commands (thanks xPMo!)
  • can draw sooth cards
  • can roll dice (thanks xPMo!)
  • can track flux for Invisible Sun dice (thanks Baconaetor!)
  • can roll saves and generate character stats for Suns Apart (thanks again xPMo!)
  • Docker support (thanks lackita!)

Usage:

  • Add The Moth bot to your Discord server with this link.
  • Make sure you grant the bot permissions to read and write messages in the channel(s) you want to use it in.
  • type / in a channel it can access and start exploring!

Running Locally

You can either run this directly or through Docker. Either way, you'll also need to create a bot token, which you can find instructions on here.

To run directly, you'll need python3 and pip3 installed. Then you can run the following:

pip3 install -r requirements.txt
MOTH_BOT_TOKEN=$your_bot_token python3 theMoth.py

If you're interested in using docker, you can build and run using the following commands:

docker build -t the-moth .
docker run -e MOTH_BOT_TOKEN=$your_bot_token the-moth

Running on a Remote Server

For the "official" instance of the bot, I pay for a cloud server and I run it off that with pm2 to ensure that the bot process stays alive with no downtime. Since I was constantly forgetting how to update the production instance of the bot after making code changes, I created a setup script which automates the process of updating some tooling and replacing the running bot process with a fresh one. So for me, the way I would run this is:

ssh root@$my_server_ip
git clone https://github.com/v01dlight/the-moth.git
cd the-moth
chmod +x setup.sh
./setup.sh "$my_bot_token"

Credits:

Moth logo image by Nika Akin from Pixabay.

the-moth's People

Contributors

v01dlight avatar xpmo avatar baconaetor avatar lackita avatar

Stargazers

Adrian-Paul Carrières avatar  avatar

Watchers

Matt Bond avatar  avatar

the-moth's Issues

[feature] Support slash commands

Discord allows bots to register /commands which can provide native hints and tab-completion, hints and tab-completion of subcommands, and rich replies.

It will take some work to rebase on interactions, but the user experience should be worth it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.