Skip to content

Update README.md to include replay mode #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
malleoz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md to include replay mode #349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,30 @@ cd out
./kinoko test -s testCases.bin
```

## Replaying a Ghost
## Running Kinoko

The simplest use of Kinoko is to just determine whether or not a ghost finishes the race with the timer matching what is present in the ghost `.rkg` file header. To replay a ghost, you can run:
Kinoko currently has two different "modes" it can operate under:
- Replay Mode
- Testcase Mode

```
./kinoko replay -g pathTo.rkg
```
---

### Replay Mode
`./kinoko replay (-g | -G | --ghost) relativePathToGhost.rkg`

This mode simply takes in a time trial ghost file and attempts to play it back. The return code will indicate whether the playback succeeded or not. The following scenarios and their respective return codes are possible:
- The ghost finished the race and the timer matches the RKG: `0` (success)
- The ghost finished the race but the timer did not match the RKG: `1` (failure)
- The ghost playback exceeded 10 minutes: `1` (failure)*

\* If a desync occurs, it is most likely to result in the timer exceeding 10 minutes.

## Creating New Test Cases
---

### Testcase Mode
When a ghost doesn't play back correctly, we want to be able to capture the exact frame that a desynchronization occurs, as well as gain insight as to what variables desynced. There are two ways to evaluate test cases in Kinoko. Both approaches require generating a `.krkg` file.

### Create KRKG
#### Create KRKG

Test cases use a custom `.krkg` file format, which stores relevant in-game memory values to validate accuracy on every frame of a race. This file is generated using a custom version of MKW-SP.

Expand Down