Skip to main content

Standalone Twitch + Bancho IRC bot for handling osu! beatmap requests.

https://travis-ci.org/pmrowla/gumiyabot.svg?branch=master

This package is used in Gumiya and is provided for users that wish to run their own bot instance and customize the bot’s functionality. If you only want a beatmap request bot, but do not need to modify or customize it, you may wish to just use stock Gumiya instead.

License:

MIT

Features

  • Support for linking a single twitch channel and single osu! account

  • Beatmap requests

  • PP info for beatmap requests (requires a Tillerino API key)

Requirements

  • Twitch IRC token - note that if you are using the token for your own Twitch account, the bot will connect to Twitch chat using your own account. It is recommended to register a secondary Twitch account for the bot.

  • Bancho (osu!) IRC credentials - note that multiaccounting in osu! is forbidden, and a bannable offense. This includes registering a bot-specific osu! account without explicit permission from osu! staff. Therefore, it is recommended to run the bot under your own osu! account. This will not affect any functionality, you will just receive map requests as in game PMs from yourself.

Installation

Via pip

pip install gumiyabot

Usage

  1. Generate a new config.ini

    gumiyabot –new-config

  2. Edit config.ini as needed (see configuration section below)

  3. Run the bot

    gumiyabot config.ini

Configuration

See config.ini.example for details on configuration options.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gumiyabot-0.1.0.tar.gz (6.3 kB view details)

Uploaded Source

File details

Details for the file gumiyabot-0.1.0.tar.gz.

File metadata

  • Download URL: gumiyabot-0.1.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gumiyabot-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7f0d5e5cc52c89cda56997c5f31f1ab717e32b52c4efe67d69f28fb6f2125f72
MD5 fd1a2a1f6cdac5eaa243a00979b657f4
BLAKE2b-256 947b8efaf82fe626d8c51a74cbf3137abaadfabad406a5b4794dee75da8668c5

See more details on using hashes here.

Release history Release notifications | RSS feed

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

1 file

0.1.2

1 file

0.1.1

1 file

This release

0.1.0 This release

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page