https://github.com/samuelyuan/polytopiasaveeditor
Command line tool to edit Battle of Polytopia save files
https://github.com/samuelyuan/polytopiasaveeditor
Last synced: 3 months ago
JSON representation
Command line tool to edit Battle of Polytopia save files
- Host: GitHub
- URL: https://github.com/samuelyuan/polytopiasaveeditor
- Owner: samuelyuan
- License: mit
- Created: 2024-04-21T01:04:08.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-24T00:19:55.000Z (5 months ago)
- Last Synced: 2024-12-24T01:25:45.225Z (5 months ago)
- Language: Go
- Homepage:
- Size: 121 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PolytopiaSaveEditor
## How to Use
### Decompress the file
The initial save file is compressed using the LZ4 algorithm. Make sure to provide the file with ".state" extension.
```
./PolytopiaSaveEditor -input=[original save file name] -mode=[decompress]
```
The new file will be created and the new filename will be the same as the original file name with ".decomp" appended at the end.
### Modify the file
There are various commands to modify the file. All changes must be be done on the decompressed file because the compressed file removes a lot of bytes for redundancy. If you modify one byte in the compressed file, you might end up modifying multiple bytes in the decompressed file.
Read-only commands:
1. list-cities: List all cities owned by each tribe. The city name and location will be shown.
2. list-units: List all units owned by each tribe. The unit type and location will be shown.
3. list-players: List all players in the game.
Commands to modify units:
1. modify-unit-tribe: Modify the unit to switch to a different tribe, but keep the same type.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=modify-unit-tribe -x=[tile's x value] -y=[tile's y value] -value=[new tribe]
```
2. modify-unit-type: Modify the unit type, but keep the same tribe.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=modify-unit-type -x=[tile's x value] -y=[tile's y value] -value=[new tribe]
```
3. reveal-tile: Reveal the tile for a player.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=reveal-tile -x=[tile's x value] -y=[tile's y value] -value=[player's tribe]
```
Commands to modify multiple units:
1. convert-tribe: Change all units under one tribe to be under a different tribe. If you use this command, you can convert all units from another player to become your units.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=convert-tribe -oldvalue=[old tribe] -value=[new tribe]
```
2. convert-all-units: This will change all units in the game to be under one tribe. This is more efficient to run if you want to convert all tribes in one command.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=convert-all-units -value=[new tribe]
```
3. reveal-all-tiles: This will reveal all tiles on the map for one player. Using this command will break the Explorer task because the game won't trigger the logic that updates and checks that you saw all the lighthouses on the map.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=reveal-all-tiles -value=[player's tribe]
```
Commands to modify tiles for all players:
1. modify-tile-terrain
2. modify-tile-owner
3. modify-tile-road
4. modify-tile-capital
Commands to modify map dimensions:
1. expand-map-rows
2. expand-map-cols
3. expand-map
Commands to modify players:
1. add-player
2. modify-player-color
Commands to modify the game:
1. reset-game: Resets the map back to the original state
The commands to modify the file will make changes within the decompressed file.
```
./PolytopiaSaveEditor -input=[decompressed file name] -mode=[command]
```
### Compress the file
The file will be compressed with the LZ4 algorithm. Make sure to provide the file with ".decomp" extension, which is the decompressed file.
```
./PolytopiaSaveEditor -input=[decompresssed file name] -mode=[compress]
```
A new file will be created and the new filename will be the same as the decompressed file name with ".comp" appended to the end.
### Overwrite existing save
Make sure you quit your current Polytopia game and go to the main menu before overwriting the save file. If you overwrite the file while the game is still in progress, the game will overwrite the file when you leave and none of your new changes will apply.
1. Change file extension to just be ".state"
2. Copy new file to save directory and overwrite existing save file in Singleplayer/ folder.
3. Go the main menu and click "Resume Game"
4. You should see all your changes take effect in the game.
## Unit Tests
```
go test -v ./...
```