Add README with usage instructions and workflow

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Julian Tabel
2026-02-25 12:02:31 +01:00
parent a5dd0d2397
commit bee1d4b46e

47
README.md Normal file
View File

@@ -0,0 +1,47 @@
# Evolve Save Editor
CLI tool for editing [Evolve](https://pmotschmann.github.io/Evolve/) browser game save files.
Export your save in Evolve (Settings > Export), run a command, and import the modified save back.
## Setup
```bash
npm install
```
## Usage
The tool reads save data from your **clipboard** by default (or from stdin/argument), applies edits, and copies the result back to the clipboard.
```bash
# Max all capped resources
node index.js --max-resources
# Set all crafted (unlimited) resources to 100,000
node index.js --set-crafted=100000
# Combine both
node index.js --max-resources --set-crafted=100000
# Read from stdin instead of clipboard
node index.js --max-resources < save.txt
# Print result to stdout instead of copying to clipboard
node index.js --max-resources --no-copy
```
## Options
| Flag | Description |
|------|-------------|
| `--max-resources` | Set all capped resources (`max > 0`) to their max |
| `--set-crafted=N` | Set all unlimited/crafted resources (`max == -1`) to N |
| `--no-copy` | Print the edited save to stdout instead of clipboard |
| `--help` | Show help |
## Workflow
1. In Evolve, go to **Settings > Export** (copies save to clipboard)
2. Run `node index.js --max-resources`
3. In Evolve, go to **Settings > Import** (pastes from clipboard)