﻿WKSR - WHITE KNUCKLE SPEEDRUN  0.7.3
========================================

WKSR is the race app for the WK Race mod: it finds matches, and shows your splits and results.
Race other players through the same seeded White Knuckle world, with live splits and a ghost of your opponent.


GETTING STARTED
---------------
1. Install the mod: in your mod manager (Thunderstore Mod Manager, r2modman or Gale), pick White Knuckle
   and install "WKRace" by WKSR. BepInExPack comes with it.
2. Run WKSR.exe from this folder. You can put the folder anywhere.
   Windows may warn you the first time because WKSR isn't code-signed: More info, then Run anyway.
   The first time, WKSR asks for your racer name (it suggests a random one).
3. Start the game with LAUNCH GAME in WKSR, or "Start modded" in your mod manager.
   WKSR never starts the game by itself. Starting the game from Steam directly does not load the mod.

When a newer WKSR is out, a GET WKSR button appears under LAUNCH GAME. Download it and replace this folder.
Your player, rating and settings are kept elsewhere (%AppData%\WKRace), so nothing is lost.


RACING
------
- FIND GAME      pairs you with whoever else is searching (ranked). Click it again to stop.
- CREATE LOBBY   gives you a short code (like WKR-ABCD-1234). Press COPY CODE and send it to a friend.
- JOIN GAME      paste a friend's code and press JOIN. Lobby races are friendly: no rating change.
- SOLO           a practice run on your own (any seed), no rating. Your best run on a seed comes back as a ghost.
- EXPORT MATCH DATA saves this session's races, splits and event log to a text file.
- REPORT BUG     describe a problem and attach screenshots; it goes to the WKSR team.

One run each: restarting is off during a race, and a death ends it. Whoever is still alive wins.

LINK STEAM (ONCE)
Ranked races need your WKSR player linked to your Steam account. Press LINK STEAM under your name:
Steam's own page opens in your browser to confirm the account. On a new PC, the same button brings your
player back with its rating. Lobbies and practice work without it.

ARTIFACT BANS
Before each race, each player bans one artifact from the Habitation lab's pool, taking turns.
The ban screen is in the game: press 1-9 (or Up/Down + Enter) to ban, 0 for no ban.
Untick "Artifact bans" in WKSR to race without bans; you are then only matched with
players who also have it off.


IN GAME
-------
F9   start your run from the menu; in practice, press twice for a fresh run
F10  press twice to forfeit (or to end a practice run)
F7   show / hide the split list
F6   show / hide the opponent ghost

If anyone disconnects, the race pauses for both players. Whoever is missing has 60 seconds
to come back, otherwise they forfeit.


TROUBLE?
--------
- "the mod has not connected": the game was started without the mod. Close it and use LAUNCH GAME.
- "version mismatch": update the mod in your mod manager and WKSR from its download page.
- Your player identity and rating are tied to  %AppData%\WKRace\client.json . Keep it safe
  (or link Steam, which brings it back on any PC).
- Privacy: the i button at the top of WKSR opens what the race server stores and why.

This app was made with AI help (Claude, by Anthropic), and play-tested by a human.
Font: VT323, under the SIL Open Font License (see Licenses).

