kiyomi-parents/kiyomi

A Discord bot centered around the Beat Saber community

Kiyomi 🦊

Overview

Discord bot that has various functionality related to Beat Saber 💜
_{Watching your Beat Saber activity very closely 👀
Measures your Score Saber PP everyday 📏}

Install dependencies

# Install requirements  
python3 -m pip install -r requirements.txt  

Starting Kiyomi

rename example.config.json to config.json and fill in your configuration details.

# Run database migrations
alembic upgrade head

# Start bot  
python3 Kiyomi.py

Lint

# Run pylint
pylint Kiyomi.py src

Code formatter

pip install black
python -m black ./Kiyomi.py ./src

Generate alembic migration

alembic revision --autogenerate -m "Change message"

kiyomi's Issues

Fix interaction defer

Almost all commands need to defer when responding.
Need to figure out how to respond to deferred messages.

typo - "unmodififiedScore" instead of "unmodifiedScore" in multiple files and also in database

Figure out how to run tests without making a million API calls

If we could have 0 API calls while running tests, that would be awesome. BUT i lack the braincells required to figure this out.

Make converters for slash command arguments

The argument converters that the Pycord library allows to use can cleanup the code quite a bit.

Update data stored in the database

This includes mostly the following models:

• Score Saber leaderboard
• Beatmap data

Add way to remove score feed channel in a guild

Should maybe remove the pp field from non-ranked scores

Twitch integration

There are 2 goals for this:

• Twitch notifications when someone goes live.
• VOD timestamps for score feed.

Feature idea: Mapper feed

Register mappers to get notifications in a Discord channel when they upload a map to Beatsaver.
Also maybe add some sort of playlist generation feature?

weighted pp change sometimes has +- in front of it instead of just +

Fallback actions for when an API is down

This affects Beat Saver and Score Saber APIs atm

Move the API into a package

This should remove some unnecessary complexity that has slowly crept into the project.
The best couse for this would be to make a github group and move the BSBot into the newly created github group. After that we would make a new repo for each of the API's we are using (Score Saber, Beat Saver, etc...). We can generate and upload packages to https://pypi.org/ and add them back to the BSBot project,

Replace logging system

The current logging system is not very friendly with the testing framework. It likes to create log files everywhere and isnt very flexible.

Haven't decided on a framwork to use or anything yet.

Difficulty on !map command looks a bit strange

Readme is outdated

Better score modifier representation in embeds

The idea is to use the beat saber score modifier icons from ingame inside the embed.

Bot hasn't fetched recent score after 3 hours

!update commands get logged twice?

Rename project

The project should be renamed to Kiyomi we should also change the references to BSBot inside the code accordingly.

I already change the offical bots discord username, but we still need to get the profile pic finished and write something for the description. Theres probably more stuff besides those that need to be changed accordingly but i cant recall everything from the top of my head. Just check the discord developer panel or whatever for the rest of the info that needs to be changed or filled.

Add support for scoresaber links in /map command

Better error handling for roles

Task exception was never retrieved
future: <Task finished name='Task-4' coro=<Loop._loop() done, defined at /home/kiyomi/Kiyomi/venv/lib/python3.9/>
Traceback (most recent call last):
  File "/home/kiyomi/Kiyomi/venv/lib/python3.9/site-packages/discord/ext/tasks/__init__.py", line 125, in _loop
    raise exc
  File "/home/kiyomi/Kiyomi/venv/lib/python3.9/site-packages/discord/ext/tasks/__init__.py", line 101, in _loop
    await self.coro(*args, **kwargs)
  File "/home/kiyomi/Kiyomi/src/utils.py", line 19, in wrapper
    res = await func(self, *args, **kwargs)
  File "/home/kiyomi/Kiyomi/src/utils.py", line 35, in wrapper
    return await func(self, *args, **kwargs)
  File "/home/kiyomi/Kiyomi/src/utils.py", line 81, in wrapper
    result = await func(self, *args, **kwargs)
  File "/home/kiyomi/Kiyomi/src/cogs/achievement_roles/tasks.py", line 37, in update_member_roles
    await self.update_member_pp_roles(guild_member)
  File "/home/kiyomi/Kiyomi/src/cogs/achievement_roles/tasks.py", line 66, in update_member_pp_roles
    await self.remove_member_role(guild_member.guild_id, guild_member.member_id, remove_role_member)
  File "/home/kiyomi/Kiyomi/src/cogs/achievement_roles/tasks.py", line 86, in remove_member_role
    await general.remove_role_from_member(
  File "/home/kiyomi/Kiyomi/src/cogs/general/general_api.py", line 46, in remove_role_from_member
    await self.actions.remove_role_from_member(guild_id, member_id, role_id, reason)
  File "/home/kiyomi/Kiyomi/src/cogs/general/actions.py", line 129, in remove_role_from_member
    discord_role = await self.get_discord_role(guild_id, role_id)
  File "/home/kiyomi/Kiyomi/src/cogs/general/actions.py", line 55, in get_discord_role
    raise RoleNotFoundException(f"Could not find role with id {role_id} in guild {discord_guild.name}")
src.cogs.general.errors.RoleNotFoundException: Could not find role with id 9 in guild Smugle Stick

Score feed shows modifiers that shouldn't be there

Discord leaderboard Score date is off by a few hours

Probably a timezone thing.

3 tests are failing in test_player.py

should probably look into it

Verify command permissions

We should make permission tiers for the bot to simplify things.

Tiers:

1. Regular user
2. Server admin/moderator
3. server owner
4. Bot owner

Replace bot output messages to discord

With the Kiyomi rebranding, the command output messages need to be replaced.

let server admins remove players

Emote framework cog

This cog will manage the available emotes for the bot to use.

Commands:

• !emote enable <discord.Emote>
  Will enable the emotes use within the bot

• !emote disable <discord.Emote>
  Will disable the emotes use within the bot

• !emoji
  Display random emote from the enabled emotes list

API Commands:

• get_emoji(":peepoHappy:")
  This will return an emoji that can be used in the bots messages and embeds.
  If an emote is unavailable then return a default placeholder emoji instead,":x:" for example.

Handle new beatmap versions

Figure out what to do with beatmaps getting updated and BeatSaver returning new beatmaps for old hashes

Add character sheet command

Just a simple comand that responds with the character sheet image.

Character sheet image:

Add missing API calls

There are a bunch of unimplemented API calls for Score Saber and other API's that we are using.

Would be cool to have those someday

PP roles feature is still broken

Roles don't seem to update when people pass a PP milestone.
Also, we should probably make sure that when people lose PP and fall below a milestone, their roles get updated accordingly.

PP change is apparently broken still/again?

Add option to restrict which scores get sent to the notification feed

Potential feature idea:
Set a restriction for which scores get sent to the notification feed.
For example, only scores that are in the global top 100 or only scores that are in the player's top 50 scores etc.

This would be an optional setting per discord server.
(The default would still be all scores.)

Move Discord token into a json config file

``It's a bit annoying to have to export the Discord token every time.
Make sure to also include the config.json file in .gitignore

The config can look something like this:
{ "discord_token": "<YOUR DISCORD TOKEN HERE>" }

Overhaul error handling for commands

This means better exceptions and the use of @command.error decorator

Add support for guild emojis

Currently kiyomi supports reposting emojis only on the global scale.
For example: You add emoji on Guild1 and kiyomi will be able to repost that in every guild.
This change would allow for global + local emojies.
Local emojis can be added by the Guiild admins.

Commands:
!emoji enable global
!emoji enable local

If you have any better ideas what the commands should look like, then feel free to change that.

Convert embeds to use Discord UI kit

Would be awesome to use discord.ext.pages for this!
Theres also Discord documentation with some pretty pictures and visual examples.

Score feed embed would have buttons under it that allow for more information:

We can use the same thing for map embeds: