Getting Started
Quick guide to get you up and running with Peglin Save Explorer
Installation
Download the Latest Release
Download the appropriate version for your operating system from the GitHub releases page.
- • Windows: peglin-save-explorer-win-x64.zip
- • macOS: peglin-save-explorer-osx-x64.tar.gz (Intel) or peglin-save-explorer-osx-arm64.tar.gz (Apple Silicon)
- • Linux: peglin-save-explorer-linux-x64.tar.gz
Extract the Archive
Extract the downloaded archive to a directory of your choice. The executable will be named peglin-save-explorer
(or peglin-save-explorer.exe
on Windows).
Add to PATH (Optional)
For easier access, add the executable to your system's PATH:
Windows:
setx PATH "%PATH%;C:\path\to\peglin-save-explorer"
macOS/Linux:
export PATH="$PATH:/path/to/peglin-save-explorer"
Initial Configuration
Automatic Detection
The tool will automatically attempt to detect your Peglin installation and save file location on first run.
Manual Configuration
If automatic detection fails, you can manually configure the paths:
# Set save file path
peglin-save-explorer config --set save_file_path="/path/to/save.data"
# Set Peglin installation path
peglin-save-explorer config --set peglin_path="/path/to/Peglin"
# View current configuration
peglin-save-explorer config --list
Default Save File Locations
- Windows:
%APPDATA%/../LocalLow/Red Nexus Games/Peglin/
- macOS:
~/Library/Application Support/Red Nexus Games/Peglin/
- Linux:
~/.config/unity3d/Red Nexus Games/Peglin/
- Steam Deck:
~/.local/share/Steam/steamapps/compatdata/1296610/pfx/
First Steps
1. Check Your Statistics
View a summary of your Peglin gameplay statistics:
peglin-save-explorer stats
2. Launch the Web Interface
Start the interactive web dashboard:
peglin-save-explorer web
This will open your browser at http://localhost:5000
3. View Your Run History
See your recent runs:
peglin-save-explorer run-history --limit 10
4. Explore Interactive Mode
Use the menu-driven interface for easier navigation:
peglin-save-explorer interactive
Troubleshooting
Save File Not Found
If the tool cannot find your save file:
- • Ensure Peglin has been run at least once
- • Check the save file location manually
- • Use the
--file
flag to specify the path
Permission Denied
On macOS/Linux, you may need to make the executable runnable:
chmod +x peglin-save-explorer
Web Interface Not Opening
If the web interface doesn't open automatically:
- • Manually navigate to http://localhost:5000
- • Try a different port:
--port 8080
- • Check if another process is using the port
Next Steps
Now that you're set up, explore these resources:
Learn about all available commands and options
Master the interactive web dashboard