GithubHelp home page GithubHelp logo

desubot's Introduction

DesuBot

A small bot for Discord, themed after the Character Karen Kujō from the anime Kiniro Mosaic

Getting Started

Prerequisites

To run the bot you need to create a new app on the Discord developer page. Create the app, give it a name and an avatar, on the next page "Create a Bot User" and copy the token. You will need to add this token in the config.json file later.

To run the -osu command you also need an an osu!-API key which needs to be added in the config.json file.

Packages that need to be installed in Python 3.6:

  • discord.py - I'm using version v0.16.12
  • urllib3
  • TinyDB
  • (optional) ujson - will speed up TinyDB if installed

Installation

Rename config.default.json to config.json and add your Data before the first use.

Values in config.json:

  • admins - UserIDs of Users which are allowed to use Admin commands
  • vips - UserIDs of Users which should recieve special replies (this feature is mostly WIP)
  • token - Your Discord bot token (important)
  • prefix - The command prefix, default is "-", e.g. "-help"
  • osuapi - Your API key form the osu! API to look up users and beatmaps

To start the bot, just run desubot.py.

Commands

  • -help - Displays a list of commands
  • -howcomf - Displays tomorrows comfiness for you or (if you append a @mention) for another user
    • aliases: -comf, -comfy
  • -roll - Rolls dice in NdN format
    • e.g. "-roll 3d6" will roll 3 six sided dice
  • -choose - Chooses between multiple given choices
    • e.g. "-choose pizza pasta" will randomly choose between "pizza" or "pasta"
  • -cgm - Gets a random picture from the CuteGirls API. If you append an anime name, it will try to get a picture from that anime
    • e.g. "-cgm Kiniro Mosaic" will return a cute picture from the anime Kiniro Mosaic together with the source
    • aliases: -cutegirl, -cutegirls, -moe
  • -fortune - Will give you your fortune in the style of an omikuji
    • alias: -omikuji
  • -picoftheday - Shows a special image every day
    • alias: -potd
  • -osu - Get data from the osu! API
    • -osu set "-osu set Cookiezi" will tie the osu! user Cookiezi to your discord user
    • -osu unset Will untie the osu! user tied to your discord user
    • -osu user "-osu user Cookiezi" displays information about osu! user Cookiezi. If you don't add a username the osu! username tied to your discord user will be used

Authors

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details

Resources

desubot's People

Contributors

kon4534 avatar sebastiangi avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

desubot's Issues

Add -osu command and features

  • Implement DB for linking a Discord User to an osu! account

  • Implement check for new Highscores

  • Implement command to manually check Accounts and Beatmaps

  • [MAYBE] Implement set of commands to manage tournament Lobbies

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.