COMPETITIVE HERO  -  V1 TEST BUILD
================================================================================

A Clone Hero-style guitar game with osu!-style scoring: timing-based accuracy
(300 / 100 / 50), performance points (PP) that rate how well you played how
hard a chart, mods, and local leaderboards.

Thanks for testing! This is an early build: things will break, and that's
exactly what I want to hear about (see "Reporting a problem" below).


WHAT YOU NEED
--------------------------------------------------------------------------------
- Windows or Linux (64-bit).
- Songs in Clone Hero format (.chart or .mid, with .ogg / .opus / .mp3 audio).
  No songs come with the game; it uses your existing Clone Hero library.
- A guitar controller (tested with the RedOctane X-Plorer / Xbox 360 guitar).
  No guitar? The keyboard works too.


GETTING STARTED
--------------------------------------------------------------------------------
1. Unzip the whole folder anywhere and run the game.
2. Choose your songs folder. If you have Clone Hero installed, the game usually
   finds your songs automatically: just pick "Use this folder". You can add more
   folders later in Settings > Song folders.
3. Calibrate (about 40 seconds). Strum along with the clicks, by ear. Please
   don't skip this: without it, hits can feel early or late even when you're
   on time. You can redo it any time from Settings > Audio & calibration.
4. Play! Pick a song, choose your difficulty, and go.


CONTROLS
--------------------------------------------------------------------------------
                    Guitar                Keyboard
Menus  move         strum up / down       arrow keys
       select       green                 Enter
       back         red                   Esc
       left/right   yellow / blue         left / right arrows
       options      orange                F1
Song select         type anywhere to search, F2 random song, F3 change sort
                    (guitar / gamepad: sort and random are in options,
                    orange fret or the Y button)
Playing             frets + strum         1 2 3 4 5 + up / down arrows
       pause        start                 Esc

Keyboard bindings for playing can be changed in Settings > Controls, which also
shows whether your guitar is detected.


HOW SCORING WORKS (SHORT VERSION)
--------------------------------------------------------------------------------
- Every note is judged by timing: 300 (great), 100, 50, or a miss. Accuracy is
  based on those, like osu!.
- Each chart has a star rating for its difficulty. A play's PP depends on the
  stars and on how accurately you played. Your profile total adds up your best
  plays, weighted like osu! (100%, 95%, 90%...). See it under Profile.
- Mods: Easy (wider timing, slower notes, less score), Hard Rock (tighter timing,
  faster notes, more score), Hidden (notes vanish before the hit line).
- Overstrumming only breaks your combo when a note is close by.


WHERE THE GAME KEEPS ITS FILES
--------------------------------------------------------------------------------
Settings > Developer has buttons that open these folders for you.

- Windows: %USERPROFILE%\AppData\LocalLow\[COMPANY]\[PRODUCT]\
- Linux:   ~/.config/unity3d/[COMPANY]/[PRODUCT]/

That folder holds your plays (plays.csv), the song cache, and the log file
(Player.log), which is the most useful thing to send with a bug report.


REPORTING A PROBLEM
--------------------------------------------------------------------------------
Please send:
1. What happened, and what you expected instead.
2. The song (name and difficulty), if it happened in a song.
3. Player.log from the folder above. Grab it before restarting the game, since
   the game replaces it on every launch. (Player-prev.log is the previous run.)
4. A screenshot or short clip, if it's something visual.


KNOWN LIMITATIONS
--------------------------------------------------------------------------------
- Guitar only for now (lead, co-op and rhythm/bass parts). No drums or vocals.
- Scores are tied to where your songs are stored: if you move or rename your
  songs folder, your scores for those songs won't follow them (yet).
- Opus songs take a moment longer to start than others.
- Linux: the guitar may need permission to be read (a USB access rule). If
  Settings > Controls doesn't show your guitar, tell me which guitar you have and
  play with the keyboard in the meantime.
- If the star symbol shows as a box, let me know.


THIRD-PARTY SOFTWARE
--------------------------------------------------------------------------------
See THIRD_PARTY_NOTICES.txt (also in Settings > Developer).
