Skip to content

No767/Kumiko

Repository files navigation

Stand With Ukraine

Kumiko (久美子)

Kumiko

Required Python Version CodeQL Snyk Lint Docker Build Tests Read the Docs Codacy Badge Quality Gate Status Lines of Code codecov GitHub release (latest SemVer) Docker Image Version (latest semver) GitHub License Discord Kumiko

A multipurpose Discord bot built with freedom and choice in mind

Kumiko (久美子)

Kumiko is a multipurpose Discord bot built with freedom and choice in mind. Kumiko provides a wide range of features, including an customizable and local economy, logging, and many more features. Integration with AniList, and others are also included.

[!IMPORTANT] I would prefer if you do not run instances of Kumiko in production. Just use the >invite command or use the Top.gg invite to have the bot on your server instead. The only reason why builds exist if for others to catch bugs and issues. The code provided is for educational use and for others to provide suggestions and feedback only.

Features

  • Customizable prefix module
  • Customizable local economy module with jobs, ranks, and more
  • Custom logging module (aka EventsLog)
  • Basic moderation commands
  • Redirects module (If you have overlapping conversations in your channels, this is for you!)
  • Global pride profiles in order to show your pride
  • Pin text so others can retrieve it
  • Antiping w/ custom settings and embeds
  • Search for memes, posts, anime, manga, and others!

And some ones that are planned:

  • Complete Web Dashboard (WIP, pinned for v2)

To see the full list of planned features, please see the roadmap here (#266)

Prefix

Kumiko uses both a prefixed command and slash commands. The currently supported prefixes are > , and /.

> is the default prefix, but this can be customized to be any custom prefix that you wish to have. For example, if you wanted to, you could set the prefix to be ? instead. These do not change the global prefix; only on the current server where you have set it up

Inviting the Bot

Currently Kumiko is nearly ready for release. Although Kumiko is still under v0, which means that there could be chances of major breaking changes, the latest releases are stable and production ready. Kumiko will be soon production ready and expect an invite for Kumiko fairly soon.

Staging versions of Kumiko may soon be releasing for public testing... Keep an eye out for that!

Support

If you would like to support me with projects like this, please consider starring this project and other ones! Bots like Kumiko, Akari, and Rin take a lot of time to make, so please consider supporting me if you can.

Maintaining and working on Kumiko as a solo developer is extremely back breaking work, with college and work on top of it. If you can, please support me on KoFi. The money will go towards to hosting Kumiko and all other server-related costs.

Getting Started

If you would like to get started, here are some links to help you with that:

Resources and Links

Licensing

Kumiko and any software that is a part of Kumiko is licensed under Apache-2.0.

Name Inspiration

Kumiko's name comes from the anime character Kumiko Oumae from the anime Hibike! Euphonium.