pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-09-14 02:42:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(gamification): align XP Rewards table with code (#12501) (#12667)

Browse Source 
Merged, with the markdown repaired.

Checked every row against `src/lib/gamification/xp.ts:138` — the table now matches `XP_REWARDS` exactly, keys and values, and the descriptions are the JSDoc lines verbatim. The old table was documenting actions that do not exist (`badge_earned`, `streak_milestone`, `referral`, `model_diversity`, `compression_use`, `skill_use`) and missing the three that do (`model_switch`, `invite_redeem`, `streak_bonus`). Good catch.

Two formatting fixes before merge: the action names were padded inside the code spans (`` `request          ` ``), which renders the trailing spaces as part of the identifier; and the unrelated MCP-tools table below had its header row flattened, losing the column alignment. Restored both and ran Prettier — the file is clean now.

Thank you for reconciling this against the source instead of guessing.
This commit is contained in:
Koosha Paridehpour
2026-09-04 22:34:17 -07:00
committed by GitHub
parent f40c77e837
commit 0df5be5b09
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/frameworks/GAMIFICATION.md
View File

@@ -236,20 +236,18 @@ xp_for_level(n) = floor(100 * n^1.5)
### XP Rewards
| Action | XP | Description |
| ------------------ | --- | --------------------------------------------------------- |
| `request` | 1 | Per successful LLM request |
| `provider_switch` | 5 | Switching to a different provider |
| `combo_create` | 10 | Creating a new combo configuration |
| `combo_use` | 2 | Using a combo (per target hit) |
| `badge_earned` | 25 | Earning any badge |
| `streak_milestone` | 15 | Reaching a streak milestone (7, 14, 30, 60, 90, 180, 365) |
| `referral` | 50 | Successfully referring a new user |
| `token_share` | 5 | Sharing tokens with another user |
| `daily_login` | 3 | First request of the day |
| `model_diversity` | 3 | Using a model not used in the past 7 days |
| `compression_use` | 2 | Using prompt compression |
| `skill_use` | 2 | Executing a skill via MCP |
| Action | XP | Description |
| ----------------- | --- | -------------------------------------------------------- |
| `request` | 1 | Per API request routed through OmniRoute |
| `provider_switch` | 5 | Switching to a different provider |
| `model_switch` | 3 | Switching to a different model |
| `combo_create` | 10 | Creating a new combo |
| `combo_use` | 2 | Using a combo for a request |
| `token_share` | 1 | Per 1 000 tokens shared with another user |
| `invite_redeem` | 50 | Redeeming an invite code |
| `daily_login` | 5 | Daily active usage (once per day) |
| `streak_bonus` | 2 | Per consecutive streak day (multiplied by streak length) |
| `badge_unlock` | 10 | Unlocking a badge |
### Award Flow
@@ -812,7 +810,7 @@ Route → CORS preflight → Body validation (Zod) → Auth (extractApiKey)
Registered in `open-sse/mcp-server/` alongside existing tools. Scoped under
the `gamification` permission scope.
| Tool | Description | Input Schema |
| Tool | Description | Input Schema | |
| -------------------------- | ------------------------------------- | ---------------------------- | --------- |
| `gamification_leaderboard` | Get leaderboard for a scope/period | `{ scope, period?, limit? }` |
| `gamification_rank` | Get caller's rank and neighbors | `{ scope }` |