Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
As of the previous commit, the program no longer crashes when Tick.wav is absent.
  • Loading branch information
penteract committed Jun 18, 2021
1 parent dac780d commit 0ead4de
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@
An **unofficial** program based on https://github.com/GHXX/FiveDChessDataInterface for saving notation from games of [5D Chess With Multiverse Time Travel](https://store.steampowered.com/app/1349230/5D_Chess_With_Multiverse_Time_Travel/).

## Usage
Start this program while 5D chess is running (or vice versa). After you finish a game with at least 4 moves, a file with the name `5dpgn<date>_<time>.txt` will be saved in the folder you ran the program from. This contains the move information, but doesn't contain the name of the variant.
It will also play the sound Tick.wav when a player in a timed game has used 1/3 of their time since the start of their turn or the previous tick.
Start this program while 5D chess is running (or vice versa). After you finish a game with at least 4 moves, a file with the name `5dpgn<date>_<time>.txt` will be saved in the folder you ran the program from. This contains the move information, but doesn't always contain the name of the variant.
It will play the sound from Tick.wav when a player in a timed game has used 1/3 of their time since the start of their turn or the previous tick.
Note: The files produced contain your timezone (as an offset from UTC), so if you consider that information sensitve, remove that field or convert it to UTC (and don't forget to change the date if necessary) before sharing. It may also be possible to infer your timezone from the filename unless that is also changed.

## Disclaimer
While it should be stable for the most part, this library may still cause crashes/desyncs or other unexpected/unwanted behaviour, hence why the developers of this project cannot be held liable for any damage caused.
While it should be stable for the most part, this program may still cause crashes/desyncs or other unexpected/unwanted behaviour, hence why the developers of this project cannot be held liable for any damage caused.

## Plans
Config file (name, which tags to include, sound file, how and whether to present time, always use white's perspective)
Automatic variant recognition (currently detects "Standard - Turn Zero", but I'm not sure it's always accurate when it claims that)

0 comments on commit 0ead4de

Please sign in to comment.