Repository navigation
osu-echo v1.0.6
Highlights & Improvements
-
Redesigned Setup Experience (Quick vs. Advanced):
- First-time launch and the
--setupwizard now feature an intuitive mode selector:- [1] Quick Setup (Recommended): Auto-detects your osu! installation, guides you through essential API keys, installs & trusts the local HTTPS certificate, and applies recommended defaults with instant Enter acceptance.
- [2] Advanced Setup: Gives power users complete control over custom folder paths (Songs, Replays, Screenshots), server bind IP and port, essential API keys, leaderboard scoring mode (Score vs. PP), profile country flags, and Bancho account sync.
- Added
-s/--setupand--reconfigurecommand-line flags to easily re-run the wizard at any time.
- First-time launch and the
-
Discord Webhook Score Integration:
- Automatically posts submitted scores and personal bests directly to your Discord server via webhooks.
- Features Discord Rich Embeds with grade-themed embed colors (Platinum/Gold SS & S, Green A, Blue B, Orange C, Red D), player profile details, beatmap information, star difficulty, score, combo, accuracy, and PP.
- Configurable via
DISCORD_WEBHOOK_URLin.env, with an optionalDISCORD_WEBHOOK_MIN_PPthreshold to filter announcements by minimum PP.
-
In-Game Score Management (
!clearscores/!clearmap):- Added the
!clearscorescommand (aliases:!clearmap,!removescores,!deletescores,!clearscore,!removemap,!clear) via BanchoBot. - Allows players to wipe their stored scores on the currently selected map or active
/npbeatmap. - Automatically recalculates profile PP, weighted overall accuracy, and total stats, immediately broadcasting a live HUD update packet (
ChoUserStats) to the client.
- Added the
-
Client Submission Hang Fix on Failed Plays:
- Fixed an issue where the osu! client remained stuck indefinitely on "Submitting score..." after failing a song.
- The server now constructs and returns valid beatmap and overall ranking charts, smoothly concluding the client's submission sequence.
- Unpassed plays correctly increment profile play count and update user stats without polluting ranked leaderboards or triggering popup notifications.
-
Minimal Default Logging & Shift-Startup Debug Mode:
- Cleaned up default console output for a sleek, minimal, high-performance terminal experience without log spam.
- Added the
-d/--debugCLI flag to enable verbose packet and route debugging on demand. - Implemented automatic Shift-key detection on Windows: simply hold Shift when launching
osu-echo.exeto boot straight into debug mode.
-
Hardened Beatmap Ranking & Diff Selection Safeguards:
- Resolved an issue where status commands (
!rank,!love,!unrank) or/npdifficulty switching could accidentally mutate canonical beatmap sets or cause custom/practice diffs to inherit parent IDs. - Strict MD5 verification now ensures cloned or edited difficulties remain completely isolated.
- Resolved an issue where status commands (
-
Magenta ASCII Logo & Smart Screen Clearing:
- The setup wizard now features a branded magenta ASCII logo on every step with smart console clearing (
cls/ ANSI purge) for a clutter-free terminal experience. - Added natural pauses after local certificate generation and hosts configuration so results can be inspected before continuing.
- The setup wizard now features a branded magenta ASCII logo on every step with smart console clearing (
-
Essential API Keys & Critical Consequence Warning:
- Reclassified osu! Legacy v1 API and osudaily API keys as essential for authentic Bancho functionality (online beatmap leaderboards, global score comparisons, and real-time PP rank calculation).
- Added clear step-by-step guidance on how to obtain keys directly within the wizard, accompanied by a prominent warning banner explaining gameplay consequences if omitted.
-
Privacy & Local Storage Transparency:
- Added explicit privacy notices throughout the wizard,
.env.example, and documentation confirming that all API keys, usernames, and passwords (stored as one-way MD5 hashes) remain strictly local on your machine and are never transmitted to third-party servers.
- Added explicit privacy notices throughout the wizard,