USC-IR documentation

This is documentation for the USC-IR (unnamed_sdvx_clone Internet Ranking) spec. This standard should be followed exactly, to avoid incompatibilities with clients and skins.

Common:

• Spec Information
• Common API Information
  • Architecture
  • Request Format
  • Response Format
  • Endpoint Commonalities
  • Shared Structures

Endpoints:

• Heartbeat - GET /
• Chart Tracked - GET /charts/:chartHash
• Record - GET /charts/:chartHash/record
• Leaderboard - GET /charts/:chartHash/leaderboard
• Score Submission - POST /scores
• Replay Submission - POST /replays

Skinning:

• IR Globals
  • IRData
    • States
    • Active
  • Request Functions
    • Heartbeat(callback)
    • ChartTracked(hash, callback)
    • Record(hash, callback)
    • Leaderboard(hash, mode, n, callback)
• Result Screen
  • ServerScore
• Song Wheel