Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/UBUNTU_makefile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ jobs:
run: make

- name: Install man page
run: sudo make -C ./man_pages && make -C ./man_pages clean
run: sudo make -C ./docs/man_pages && make -C ./docs/man_pages clean
30 changes: 30 additions & 0 deletions docs/CLI_Timer_Session_format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Introduction

This is the secification for the `*.CLI_T_S` file (new) binary format.
<br>
This is for version 1 of the file type.

# Description

## Metadata
Magic bytes: `CLI_TIMER{version_num}` (`43 4c 49 5f 54 49 4d 45 52 01`)
<br>
Then there will be the initial seed in binary so that `--seed` stays consistent.

## Main body
In the original format it went `{scramble}§{time}~{Comment}`. <br>
If there were penalties (i.e. +2 or DNF) it would do `{time}+` or `DNF({time})`.
<br>

In this new version, it will instead be `[02]{scramble}[03]{penalty_num}{time}[02]{comment}[03]{rng_usage_count}`.

This is where `[02]` and `[03]` are the ASCII codes for "start of text" and "end of text" respectively. <br>
The `{scramble}` and `{comment}` sections are just raw strings with no compression (for version 1; hopefully not for future versions). <br>
`{penalty_num}` will be: <br>
* 1: No penalty
* 2: +2
* 3: DNF

The `{time}` will be a binary representation for a float for the amount of seconds. For example, the time `1:23.45` would be stored as `42 a6 e6 66`

Finally there will be the `{rng_usage_count}` so that when using a seed, it picks up where it left off.
File renamed without changes.
File renamed without changes.
File renamed without changes.