Yotsu Documentation
Welcome to the official technical and feature documentation for Yotsu. Yotsu is an advanced, high-performance companion bot built specifically for the Discord Karuta card collection game.
Core Philosophy: Completely Free · 100% Modular · Interactive Configuration · Zero Spam.
The Free-Forever Promise
Unlike other Discord bot companions that lock essential utility features behind payment tiers, Patreon pledges, or mandatory voting sites, Yotsu is 100% free forever.
Every single player and server receives unrestricted access to all 11 modules, OCR drop scanning, print recognition, high-wishlist alerts, and 50-slot personal wishlists from the moment Yotsu joins your server. There are no paywalls, hidden limits, or subscription prompts.
Completely Modular Architecture
No two Discord communities are the same. A casual social lounge may only want quick card code copying, while a competitive card clan may demand multi-worker OCR scanning, low-print recognition, and high-wishlist drop forwarding.
Yotsu is built around an isolated modular architecture. Every single feature can be toggled on or off individually per server. Disabled modules execute zero background processing and never send messages or reactions to your channels, keeping your Discord clean, fast, and free of clutter.
Interactive Server Configuration
Configuring your server no longer requires memorizing terminal-style syntax or typing individual subcommand flags. With Yotsu, server administrators configure everything through a unified, rich Discord dashboard invoked with:
/config Requires Manage Server
✅ Daily Solver — Highlight the correct answer for daily quizzes
✅ Drop Scanning — OCR scanning with print tiers & wishlist badges
Category Navigation & Toggles
The dashboard includes two primary interactive dropdown menus:
- Category Selector: Switch between Overview, Utility & QoL, Drop Helpers, Drop Alerts, and Calculators & Stats to view detailed configuration statuses, assigned roles, and channel mappings.
- Feature Toggle Menu: Instantly flip any feature between ✅ Enabled and ❌ Disabled with a single tap. Changes are immediately persisted in the server database and updated in Yotsu's live memory cache.
Dedicated Setup Modals
When navigating to the Drop Alerts category, the dashboard presents direct modal setup buttons:
- 🎯 Setup Peak Drop: Opens a native Discord modal allowing admins to type or mention the target ping role and configure the minimum wishlist threshold (e.g.
1000). - ⏩ Setup Peak Forward: Opens a modal to specify the announcement channel (e.g.
#peak-drops) and minimum wishlist threshold for automated drop forwarding.
Bulk Controls
Quickly adapt Yotsu to your server's needs with one-click bulk controls:
- Enable All / Category: Turns on all features globally or within the selected category.
- Disable All / Category: Turns off all features globally or within the selected category.
- Refresh: Synchronizes live guild cache with any external database updates.
Code Extractor
Toggle Key: code_extractor
Copying individual card codes on mobile Discord is frustrating and slow. Code Extractor monitors card lookups and collections, automatically outputting clean, copy-pasteable blocks with the exact card code.
Supported Triggers:
k!vorkv— Single card inspectionk!ciorkci— Detailed card viewk!corkc— Multi-card collection pages
Simply tap the codeblock output on mobile to copy the code directly to your clipboard for instant trading, tagging, or grabbing.
Daily Quiz Solver
Toggle Key: daily_solver
Karuta's daily bulletin board (kdaily) rewards players for answering anime trivia questions. Yotsu listens for bulletin board embeds, queries our verified quiz database, and immediately replies with the correct answer option.
Never lose your daily streak or forfeit bonus tickets due to unfamiliar anime questions.
Character & Series Alias Lookup
Command: /alias name: <character> [series: <series>]
In Karuta, many characters are registered under alternate names, nick-names, or original Japanese romaji. The /alias slash command provides instant access to all known aliases for any character in the database.
Highlights & Capabilities:
- Live Autocomplete: As you type into either the
nameor optionalseriesfield, Discord suggestions auto-fill with matching characters and series names. - Interactive Candidate Selector: If a query matches multiple characters across different series, Yotsu presents an interactive dropdown menu to pick the exact character you want.
- Fuzzy Matching Fallback: If there is a slight typo, Yotsu automatically falls back to intelligent fuzzy search to identify the character.
Drop Expiration Timer
Toggle Key: drop_timer
Karuta card drops expire within a short window if players do not react in time. When Drop Timer is enabled, Yotsu reacts to the drop embed with an hourglass emoji (⏳) and posts a prominent warning alert exactly 10 seconds before expiration, ensuring you and your server members never miss an unclaimed card.
Drop Scanning, Print Recognition & Wishlist Badges
Toggle Key: drop_scanning
Yotsu incorporates an advanced Optical Character Recognition (OCR) and template-matching pipeline running on a dedicated worker pool. When a card drop occurs (3-card or 4-card), Yotsu analyzes the drop image in parallel and posts a comprehensive breakdown:
1. Print Scanner Recognition
The scanner reads card numbers directly from drop graphics and badges them by print rarity:
2. Wishlist Star Tier Indicators
Card popularity is dynamically resolved against stored wishlist metrics:
- ⭐ Tier 1: 100 – 499 Wishlist
- ⭐⭐ Tier 2: 500 – 999 Wishlist
- 🌟 Tier 3 (High Grail): 1,000+ Wishlist
3. High-Performance Perceptual Hash Cache
Frequent card art and series banners are cached via cryptographic image hashes in SQLite. Common drops evaluate in milliseconds without unnecessary OCR recomputation.
Server Drop Ping
Toggle Key: server_drop_ping
Notifies dedicated droppers whenever a server drop appears. Yotsu automatically maintains a designated server drop role.
Self-Assignment: Server members can type /server_drop_ping at any time to add or remove the role from their profile without needing administrative assistance.
Series Wishlist Manager
Command: /series_wishlist [query: <series>]
Receive alerts whenever a card from your favorite anime, manga, or gaming series drops in the server!
- Personal 50-Slot Capacity: Every player can track up to 50 distinct series for free.
- Interactive UI Manager: Running
/series_wishlistdisplays a paginated list of your tracked series with search buttons and removal dropdowns. - Fuzzy OCR Matching: Recognizes series even when OCR encounters minor background distortions or stylized fonts.
- Cross-Server Drop Alerts: Your tracked wishlist follows your Discord account across all servers where Yotsu and Series Wishlist are active.
Yotsu Character Wishlist Manager
Command: /wishlist [query: <character>] [series: <series>]
Track specific grail characters and get pinged the second they drop in any active channel!
- Personal 50-Slot Capacity: Add up to 50 individual characters with zero premium restrictions.
- Interactive Character Search: Search by character name and filter by series to disambiguate characters sharing identical names across different anime.
- Targeted Notifications: Never miss your dream card drop when chatting in other channels or playing games.
Peak Drop Ping (Grail Alerts)
Toggle Key: peak_drop_ping
Prevent ping fatigue by mentioning members only when truly valuable cards drop! Peak Drop Ping filters server drops against a customizable minimum wishlist threshold (default: 1,000+ WL).
- Customizable Threshold: Server admins configure the exact threshold in
/configvia the Setup Peak Drop modal. - Self-Assignment: Members use
/peak_drop_pingto toggle the grail hunter role on their profile. - Server Drop Protection: Ignores low-wishlist cards to ensure mentions remain exciting and meaningful.
Peak Drop Forwarding
Toggle Key: peak_drop_forwarding
Automatically re-route and showcase high-value drops in a dedicated announcement feed (e.g. #peak-drops or #grail-showcase).
- Native Discord Forwarding: Uses Discord's modern message forwarding API with a fallback alert link if permissions restrict native forwards.
- Custom Channel & Threshold: Configured effortlessly inside
/configvia the Setup Peak Forward modal. - Channel Loop Safeguard: Automatically skips forwarding if the original card drop occurred inside the target announcement channel itself.
Worker Effort Calculator
Toggle Key: effort_calculator
Maxing out worker node productivity is essential for mining bits and gems. When viewing worker details with k!wi or kwi, Yotsu automatically calculates:
- Base toughness, quickness, and vanity formulas.
- Wellness percentage scaling and impact on total yield.
- Style bonus multipliers (frames, dyes, morphs).
- Efficiency profile indicating how close the card is to optimal output.
Bit & Morph Counter
Toggle Key: bit_counter
Managing vast bit inventories across iron, gold, wood, and celestial bits can be tedious. When viewing bit inventories (k!bi / kbi), Yotsu calculates:
- Total accumulated bit counts across all ore and material categories.
- Total available morphs supported by your current bit balances.
- Convenient formatted summaries with comma separation for effortless reading.
Slash Commands Directory
All commands use native Discord slash interactions with autocomplete and interactive components.
| Command | Arguments | Permission | Description |
|---|---|---|---|
/config |
None | Manage Server | Opens the interactive Server Configuration Dashboard with category navigation, feature toggles, setup modals, and bulk actions. |
/alias |
name series | Everyone | Displays all known aliases for a character with live Discord autocomplete and interactive selection menus. |
/wishlist |
query series | Everyone | Interactive character wishlist manager. Track up to 50 characters with pagination and cross-server drop notifications. |
/series_wishlist |
query | Everyone | Interactive series wishlist manager. Track up to 50 anime/manga series with pagination and cross-server drop notifications. |
/server_drop_ping |
None | Everyone | Toggles the general Server Drop Ping notification role on your profile. |
/peak_drop_ping |
None | Everyone | Toggles the Peak Drop Ping (high-wishlist grail alert) role on your profile. |
Roadmap & Version Highlights
Yotsu is actively developed and updated. Below is a summary of delivered enhancements in v1.5+ and planned future developments: