Skip to content

Commit

Permalink
Bump version/ update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Seb Ospina <[email protected]>
  • Loading branch information
sebosp committed Mar 1, 2024
1 parent 42bd6d1 commit a97c5f5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "s2protocol"
description = "A parser for Starcraft II - Replay format, exports to different target formats"
version = "3.0.3"
version = "3.0.4"
authors = ["Seb Ospina <[email protected]>"]
edition = "2021"
readme = "README.md"
Expand Down
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ information it packs.

From the available data, analytics, visualizations and generative art can be created, for example
by using
- jupyter notebook in [s2-polars-data-analysis](https://github.com/sebosp/s2-polars-data-analysis)
- [rerun](https://github.com/rerun-io/rerun) : See the repo [swarmy](https://github.com/sebosp/swarmy)
- [lyon](https://github.com/nical/lyon) (PoC in progress in cooper)
- [yew](https://github.com/yewstack/yew) [cooper](https://github.com/sebosp/cooper)
- [eframe/egui](https://github.com/emilk/egui): See repo [eframes-c2](https://github.com/sebosp/eframe-sc2)
- [bevyengine/bevy](https://github.com/bevyengine/bevy) can be used to see:
Expand Down Expand Up @@ -130,13 +130,6 @@ $ # List the max number of minerals that were lost in per map when the army was
- [ ] Support for MPQ embedded file: `replay.gamemetadata.json`
- [ ] Support for MPQ embedded file: `replay.attributes.events`

## Current issues

In the arrow file generation, sha256 digest is used to detect duplication/etc.
This inflates the size of the rows. Even tho it's slightly less than long directory names.
Perhaps using short rev-parse for sha256 may be better, find something like 7-characters unique combinations
And use that instead of the long sha256 form.

## version compatibility.

After a bit of testing, it seems most of the types are compatible between versions, so only when they differ would they make part of the protocol version.
Expand All @@ -160,7 +153,7 @@ RUST_LOG_SPAN_EVENTS=full RUST_LOG=debug cargo watch -i src/versions/protocol897
# Additionally some code to transform from Protocol-Specific to Protocol-Agnostic was added, TODO: Add to generator.rs
```

## JSON Sources
## JSON Spec Sources

[Blizzard/s2protocol repo](https://github.com/Blizzard/s2protocol)

0 comments on commit a97c5f5

Please sign in to comment.