![CI status](https://github.com/LimeEng/wthor/workflows/CI/badge.svg)
[![Latest version](https://img.shields.io/crates/v/wthor.svg)](https://crates.io/crates/wthor)
![Fuzz status](https://github.com/LimeEng/wthor/workflows/Fuzz/badge.svg)

# Wthor

Wthor is a rather archaic data-format used extensively by the [Fédération Française d'Othello](https://www.ffothello.org/informatique/la-base-wthor/) to document games of Othello. As a result of their massive collection, Wthor has become a popular data-format in this space. Unfortunately, the only [official documentation](https://www.ffothello.org/wthor/Format_WThor.pdf) is in French. Machine-translating the specification with Google Translate worked reasonably well and the result can be [found here](/spec/wthor_spec.pdf).

The translated documentation is however still imprecise and as a result, this library makes very few assumptions about the data. The data extracted is rarely processed in any way but presented as is.

Three types of Wthor files can be parsed as of now. They commonly have the extensions `.jou`, `.trn` and `.wtb`.

- `.jou` - This type of file contains a list of players.
- `.trn` - This type of file contains a list of tournaments.
- `.wtb` - These are "game files", essentially a long list of games. Each game contain a header with additional information, such as the tournament it was played at and the name of the players. They are however not directly represented in the structure but instead contains an index which corresponds to an entry in the associated `.jou` and `.trn` files.

Solitaire files are currently not supported.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
wthor = "0.5"
```

Optionally, opt into using [Serde](https://serde.rs/) by enabling the feature flag `serde`.
```toml
[dependencies]
wthor = {version = "0.5", features = ["serde"]}
```

## Examples

Examples can be [found here](/examples).