Code Monkey home page Code Monkey logo

klefki's Introduction

Klefki

How to use

  1. Make a copy of config.json.example and name it config.json.
  2. Set your bot's token ID.
  3. (Optional) Set your command prefix to whatever you like.
  4. Install the following for your host:
    • Python 3.9.x (and its respective pip)
  5. Run pip install -r requirements.txt
  6. Run the following command:
    • UNIX-based: python3 klefki.py
    • Windows: py klefki.py

Optional functionality

  • Moon Black 2 Discord server related commands can be set per-server. Pokemon XY Demakes Discord server related commands are also set in this fashion.
    • Use command config commands add <mb2 | xyd>.
  • Moderation roles can be added per-server. The server owner will have absolute permissions over the bot within the server, regardless of whether a moderator role is set.
    1. Use command config modrole add <role ID>.
    2. This role will now have access to moderation commands over the bot. i.e. kick, ban, mute, etc.
  • Mute roles can be added per-server. Mute roles will need to be manually configured, however.
    1. Configure @everyone with default settings, and your Mute role with disabled Send message permissions.
      • This is the ideal configuration for a mute role: however, configure however you think a mute should be applied.
    2. Use command config muterole add <role ID>.
  • Automatic roles can be added on join, per-server.
    • Use command config autorole enable and config autorole add <role ID>.

License

    Copyright (C) 2021-present lifehackerhansol

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Credits

  • Discord.py: This wouldn't exist without it
  • Nintendo Homebrew's Kurisu: utils.py error embeds, load.py, blah.py, moderation commands

klefki's People

Contributors

lifehackerhansol avatar dependabot[bot] 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.