hartl3y94 / kumiko

A multipurpose Discord bot built with freedom and choice in mind

Kumiko (久美子)

A multipurpose Discord bot built with freedom and choice in mind

Kumiko (久美子)

Kumiko is a multipurpose fork of Rin built with freedom and choice in mind. Kumiko allows you to decide on whether you wish to use the services provided. Kumiko includes a opt-in economy system, and soon a web dashboard (pinned for v2.0). Just like Rin, Kumiko is completely written in Python, and is a direct upstream fork from Rin. Which means that all of Rin's 15+ services are directly integrated into Kumiko.

Rin (リン)

Rin is a Discord bot written with Pycord and Python, and is focused on fetching data from third-party services with lighting performance in mind. For example, you could look up some memes with the Reddit service, or find your favorite anime with the MyAnimeList service. Rin supports a lot of services, such as Twitter, MangaDex, Reddit, YouTube, Hypixel, and many more. Rin is also designed to be fast, and uses Uvloop under the hood, which is 2 times faster than Node.js and reaches the same speeds as many Go programs. On top on that, Rin is powered by the fatest JSON parser in the world, SIMDJSON. For more info, please check out the Docs.

For the future of Rin, please see this gist.

Features

• An Opt-In Economy System with jobs system and marketplace (WIP, pinned for v1)
  • Includes a marketplace and an auction house
  • Custom currency (Lavnder Petals)
  • Custom jobs (WIP)
  • Rank system (WIP)
  • Custom quests
• Wish Sim (WIP, pinned for v1)
• Complete Web Dashboard + Custom Embeds (WIP, pinned for v2)
• AI Driven GAN Anime Waifu Generator (Not implemented yet)
• Selector Roles (pinned for v2)
• All of the services from upstream Rin

Rin's Supported Services

Kumiko comes with integration from 15+ services. Some of these services that are fully supported and integrated include:

• AniList
• MyAnimeList
• Twitter
• Modrinth
• YouTube
• Waifu.IM
• MangaDex
• Twitch
• GitHub

And many more! For a full list, see the Supported Services page.

Prefix

Kumiko uses the same prefix as Rin, which is /.

Inviting the Bot

Still in early production. Not ready for release yet. Currently Kumiko is under v0, which means it's alpha-level software, and thus should not be used in production. Kumiko is subject to breaking changes within this version. Kumiko will be ready to be invited once it reaches to v1, which is production-ready software.

Support

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

Getting Started

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

• Getting Started (For Developers)
• Contributing
• Documentation

Licensing

Kumiko being a direct upstream fork of Rin, is licensed under the same license as Rin, which is Apache-2.0.

FOSSA Status

Name Inspiration

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