Skip to content

Commit

Permalink
Add READMEs to ark nova (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
shaldengeki authored Jul 25, 2024
1 parent ac80eae commit cb50acc
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
29 changes: 29 additions & 0 deletions ark_nova_stats/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ark_nova_stats

A collection of tools and services for analyzing Ark Nova games.

See the README.md in individual directories.

## API

This is a webapp designed to store Ark Nova replays, in BGA format.

To run, do:
```bash
docker compose -f docker-compose.yaml -f docker-compose.override.yaml up
```

To deploy to production:

```bash
cd api
fly deploy
```

## bga_log_parser

A Python library used to parse Ark Nova gameplay logs in BGA format.

## emu_cup

A set of scripts I'm using to analyze replays from the Emu Cup, an Ark Nova tournament between high-ranked players on BGA.
15 changes: 15 additions & 0 deletions ark_nova_stats/bga_log_parser/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# bga_log_parser

A Python library to parse Ark Nova gameplay logs in BGA format.

First, download the gameplay logs in JSON format somewhere on your computer. Then:

```python
import json
from ark_nova_stats.bga_log_parser.game_log import GameLog

with open('path/to/my/replay.json', 'r') as f:
log = GameLog(**json.loads(f.read().strip()))

print(log.winner)
```

0 comments on commit cb50acc

Please sign in to comment.