Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Apeuriox/lazybot-renewal/llms.txt

Use this file to discover all available pages before exploring further.

Lazybot is a self-hosted osu! companion bot for Discord and QQ (OneBot protocol). It lets players look up scores, visualize best performances, simulate no-choke runs, compare stats against rivals, and earn badges through map-pack challenges — all with rich SVG-rendered graphic panels.

Introduction

Learn what Lazybot does and what makes it different from other osu! bots.

Quickstart

Build and run Lazybot locally in under 15 minutes.

Configuration

Full reference for every setting in application.yaml.

Deployment

Deploy Lazybot to a Linux server with systemd supervision.

Explore Commands

Score Lookup

Query any score by beatmap ID, mod, or mode.

Best Performance

Inspect, list, and simulate BP with no-choke and what-if tools.

Recent Scores

Pull the latest passes or full recent plays.

Profile & Card

Full-featured player profile panel and Moelleux card.

PP Tools

PP+ breakdown, ppmap scatter plot, and recommended difficulty.

Badge System

Earn, redeem, and showcase badges through challenge runs.

How It Works

1

Deploy the bot

Clone the repo, fill in application.yaml, set up the database, and run the Spring Boot jar.
2

Link your osu! account

Use /link <username> or /link oauth to bind your osu! identity to Lazybot.
3

Query your stats

Run /bp, /score, /profile, /plus, and many more commands directly in chat.
4

Earn badges

Complete challenge map packs with /challenge and redeem keys with /redeem.
Lazybot is licensed under GPL-3.0. Self-hosting requires Java 21, a MySQL-compatible database, and valid osu! API credentials.

Build docs developers (and LLMs) love