add readme

This commit is contained in:
2026-05-06 16:43:30 -04:00
parent 7b673ef443
commit c1bcf6b74f

24
README.md Normal file
View File

@@ -0,0 +1,24 @@
# umadump-gametora
Convert [Umadump](https://github.com/Werseter/umadump) exports into [GameTora collection](https://gametora.com/umamusume/collection-tracker) backups.
This program is meant to be a temporary helper until GameTora has full Umadump import built in, which should be soon.
Therefore, it does not provide a pretty UI.
## Usage
With a recent Go toolchain installed, open a terminal and run:
```
umadump
go run git.sunturtle.xyz/zephyr/umadump-gametora@latest
```
If you run umadump in a different directory, pass that directory with `-dump` on the `go run` line.
E.g., I run umadump in `C:\Users\zephyr\Downloads`, so the command I use is
```
go run git.sunturtle.xyz/zephyr/umadump-gametora@latest -dump C:\Users\zephyr\Downloads
```
This writes the collection to a file like `uma-col-all-2026-05-06.json` which you can use with the `Import from a file instead` link in the `Import` section of the `Backup` menu on the GameTora collection tracker page.