GithubHelp home page GithubHelp logo

book-of-stars's Introduction

Book of Stars (WIP)

A discord bot to save quotes from your favorite servers and play them back.

Usage

  1. cargo install diesel
  2. diesel migrations run to make an empty sqlite database
  3. Copy sample.env to .env
  4. Fill in your discord token and guild id in .env
  5. Compile and run the bot
  6. Use the star emoji reaction to tag messages as quoths in your server
  7. Use !quoth in discord to get a random quoth and !quoth <username> to get one from a particular user (checks discord id then nicknames)

The star emoji is a constant in the src file and can be changed.

Known Issues

  • Currently the bot only works with one server at a time. The data model needs tweaking to support more.

TODO

  • Write a basic data model
  • Write code to add quoths and query them
  • Write bot to record quoths using reactions
  • Add bot functionality to query and return quoths
  • Write utility to load legacy quoths from slack
  • Write utility to retrieve pinned messages as quoths (Do them via message id) (do this via message snowflake ids instead)
  • Functionality to pick your own emojis via .env
  • Functionality to save quoth via message id
  • Functionality to delete bad or buggy quoths

History

This bot is a re-implementation of my original quoth bot for slack. That was implemented in Go and used Mongo (ick) for storage. Now we use Rust, a relational database, and connect to Discord. The world is better.

book-of-stars's People

Contributors

hyena avatar

Watchers

 avatar  avatar

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.