poseidon/Fallout-Shelter-Save-Editor
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bored
2025-08-05 05:21:50 +00:00
parent f1b6e2b9ce
commit d6ea8d8b35
1 changed files with 209 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

418
README.md
View File

@@ -1,210 +1,210 @@
# Fallout Shelter Save Editor # Fallout Shelter Save Editor
A modern, cross-platform save editor for Fallout Shelter built with Electron.js. Features AES decryption support and a beautiful, intuitive interface. A modern, cross-platform save editor for Fallout Shelter built with Electron.js. Features AES decryption support and a beautiful, intuitive interface.
## Screenshots ## Screenshots
### Main Interface ### Main Interface
![Main Interface](assets/main-interface.png) ![Main Interface](assets/main-interface.png)
*Welcome screen with quick access to all major features* *Welcome screen with quick access to all major features*
The editor provides four main functions: The editor provides four main functions:
- 💰 **Resource Management** - Edit caps, food, water, power, and consumables - 💰 **Resource Management** - Edit caps, food, water, power, and consumables
- 👥 **Dweller Editor** - Modify dweller stats and equipment - 👥 **Dweller Editor** - Modify dweller stats and equipment
- 🏠 **Vault Information** - View and edit vault details - 🏠 **Vault Information** - View and edit vault details
- 🛡️ **Safe Editing** - Automatic backups and validation - 🛡️ **Safe Editing** - Automatic backups and validation
## Latest Release ## Latest Release
### Version 1.0.0 (August 2025) ### Version 1.0.0 (August 2025)
🎉 First stable release with all core features implemented! 🎉 First stable release with all core features implemented!
**Download:** **Download:**
- [Windows (64-bit)](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases/download/v1.0.0/FalloutShelterEditor-Setup-Win-x64.exe) - [Windows (64-bit)](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases/download/v1/%2FFalloutShelterEditor-Setup-Win-x64.exe)
- [macOS (Universal)](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases/download/v1.0.0/FalloutShelterEditor-Setup-Mac.dmg) - [macOS (Universal)](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases/download/v1.0.0/FalloutShelterEditor-Setup-Mac.dmg)
- [Linux (AppImage)](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases/download/v1.0.0/FalloutShelterEditor-Setup-Linux.AppImage) - [Linux (AppImage)](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases/download/v1.0.0/FalloutShelterEditor-Setup-Linux.AppImage)
**What's New:** **What's New:**
- ✨ Initial release with full save file editing support - ✨ Initial release with full save file editing support
- 🔒 AES encryption/decryption implementation - 🔒 AES encryption/decryption implementation
- 🎨 Modern, user-friendly interface - 🎨 Modern, user-friendly interface
- 💾 Automatic backup system - 💾 Automatic backup system
- 🔧 Resource and vault management features - 🔧 Resource and vault management features
[View all releases](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases) [View all releases](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases)
## Features ## Features
✨ **Modern Interface** - Beautiful, dark-themed UI with smooth animations ✨ **Modern Interface** - Beautiful, dark-themed UI with smooth animations
🔐 **AES Decryption** - Properly decrypt and encrypt Fallout Shelter save files 🔐 **AES Decryption** - Properly decrypt and encrypt Fallout Shelter save files
💰 **Resource Editing** - Edit caps, food, water, power, stimpaks, and more 💰 **Resource Editing** - Edit caps, food, water, power, stimpaks, and more
🏠 **Vault Management** - Modify vault name, mode, and theme 🏠 **Vault Management** - Modify vault name, mode, and theme
👥 **Dweller Overview** - View dweller information and stats 👥 **Dweller Overview** - View dweller information and stats
📝 **Raw Data Access** - Direct JSON editing for advanced users 📝 **Raw Data Access** - Direct JSON editing for advanced users
💾 **Safe Backups** - Automatic backup creation before modifications 💾 **Safe Backups** - Automatic backup creation before modifications
⚡ **Cross-Platform** - Works on Windows, macOS, and Linux ⚡ **Cross-Platform** - Works on Windows, macOS, and Linux
## Installation ## Installation
### Option 1: Download Pre-built Binary ### Option 1: Download Pre-built Binary
1. Go to the [Releases](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases) page 1. Go to the [Releases](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/releases) page
2. Download the appropriate version for your operating system 2. Download the appropriate version for your operating system
3. Install and run the application 3. Install and run the application
### Option 2: Build from Source ### Option 2: Build from Source
#### Prerequisites #### Prerequisites
- Node.js 16 or higher - Node.js 16 or higher
- npm or yarn - npm or yarn
#### Steps #### Steps
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor.git git clone https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor.git
cd Fallout-Shelter-Save-Editor cd Fallout-Shelter-Save-Editor
``` ```
2. Install dependencies: 2. Install dependencies:
```bash ```bash
npm install npm install
``` ```
3. Run in development mode: 3. Run in development mode:
```bash ```bash
npm run dev npm run dev
``` ```
4. Build for production: 4. Build for production:
```bash ```bash
npm run build npm run build
``` ```
## Usage ## Usage
### Loading a Save File ### Loading a Save File
1. Launch the application 1. Launch the application
2. Click "Get Started - Open Save File" or use File → Open Save File 2. Click "Get Started - Open Save File" or use File → Open Save File
3. Navigate to your Fallout Shelter save directory: 3. Navigate to your Fallout Shelter save directory:
- **Windows**: `%LOCALAPPDATA%/FalloutShelter/` - **Windows**: `%LOCALAPPDATA%/FalloutShelter/`
- **macOS**: `~/Library/Application Support/FalloutShelter/` - **macOS**: `~/Library/Application Support/FalloutShelter/`
- **Android** (with file access): `/Android/data/com.bethsoft.falloutshelter/files/` - **Android** (with file access): `/Android/data/com.bethsoft.falloutshelter/files/`
### Editing Resources ### Editing Resources
1. Switch to the "Resources" tab 1. Switch to the "Resources" tab
2. Modify the values for caps, food, water, power, etc. 2. Modify the values for caps, food, water, power, etc.
3. Click "Apply Changes" to save modifications 3. Click "Apply Changes" to save modifications
4. Use "Max All" for maximum resource values 4. Use "Max All" for maximum resource values
### Vault Information ### Vault Information
1. Go to the "Vault Info" tab 1. Go to the "Vault Info" tab
2. Edit vault name, mode (Normal/Survival), and theme 2. Edit vault name, mode (Normal/Survival), and theme
3. Apply changes when ready 3. Apply changes when ready
### Advanced Editing ### Advanced Editing
1. Use the "Raw Data" tab for direct JSON editing 1. Use the "Raw Data" tab for direct JSON editing
2. Format JSON for better readability 2. Format JSON for better readability
3. Copy data to clipboard for external editing 3. Copy data to clipboard for external editing
### Saving Changes ### Saving Changes
1. Use Ctrl+S (Cmd+S on Mac) or File → Save 1. Use Ctrl+S (Cmd+S on Mac) or File → Save
2. Create backups with File → Create Backup 2. Create backups with File → Create Backup
3. Use File → Save As to save to a different location 3. Use File → Save As to save to a different location
## Save File Locations ## Save File Locations
### Windows ### Windows
``` ```
%LOCALAPPDATA%/FalloutShelter/ %LOCALAPPDATA%/FalloutShelter/
``` ```
### macOS ### macOS
``` ```
~/Library/Application Support/FalloutShelter/ ~/Library/Application Support/FalloutShelter/
``` ```
### Android (Rooted/File Access) ### Android (Rooted/File Access)
``` ```
/Android/data/com.bethsoft.falloutshelter/files/ /Android/data/com.bethsoft.falloutshelter/files/
``` ```
## Technical Details ## Technical Details
### Encryption ### Encryption
Fallout Shelter save files use AES-CBC encryption with: Fallout Shelter save files use AES-CBC encryption with:
- **Key**: `a7c2f3f367a2e2e2f0f2b6b1b3b4b5b6b7b8b9babbbcbdbebfc0c1c2c3c4c5c6c7` (hex) - **Key**: `a7c2f3f367a2e2e2f0f2b6b1b3b4b5b6b7b8b9babbbcbdbebfc0c1c2c3c4c5c6c7` (hex)
- **IV**: `7475383967656A693334307438397532` (hex) - **IV**: `7475383967656A693334307438397532` (hex)
- **Mode**: CBC with PKCS7 padding - **Mode**: CBC with PKCS7 padding
- **Encoding**: Base64 - **Encoding**: Base64
### Save Structure ### Save Structure
The decrypted save file is a JSON object containing: The decrypted save file is a JSON object containing:
- `vault.storage.resources` - Resource amounts (caps, food, water, etc.) - `vault.storage.resources` - Resource amounts (caps, food, water, etc.)
- `vault.VaultName` - Vault name - `vault.VaultName` - Vault name
- `vault.VaultMode` - Game mode (Normal/Survival) - `vault.VaultMode` - Game mode (Normal/Survival)
- `dwellers.dwellers` - Array of dweller data - `dwellers.dwellers` - Array of dweller data
- And much more... - And much more...
## Development ## Development
### Project Structure ### Project Structure
``` ```
├── main.js # Electron main process ├── main.js # Electron main process
├── renderer.js # Renderer process (UI logic) ├── renderer.js # Renderer process (UI logic)
├── index.html # Main UI ├── index.html # Main UI
├── styles.css # Styling ├── styles.css # Styling
├── package.json # Dependencies and scripts ├── package.json # Dependencies and scripts
└── assets/ # Icons and images └── assets/ # Icons and images
``` ```
### Building ### Building
```bash ```bash
# Development # Development
npm run dev npm run dev
# Build for current platform # Build for current platform
npm run build npm run build
# Build for specific platforms # Build for specific platforms
npm run build-win # Windows npm run build-win # Windows
npm run build-mac # macOS npm run build-mac # macOS
npm run build-linux # Linux npm run build-linux # Linux
``` ```
## Contributing ## Contributing
1. Fork the repository 1. Fork the repository
2. Create a feature branch: `git checkout -b feature-name` 2. Create a feature branch: `git checkout -b feature-name`
3. Make your changes and test thoroughly 3. Make your changes and test thoroughly
4. Commit your changes: `git commit -am 'Add feature'` 4. Commit your changes: `git commit -am 'Add feature'`
5. Push to the branch: `git push origin feature-name` 5. Push to the branch: `git push origin feature-name`
6. Submit a pull request 6. Submit a pull request
## Safety & Disclaimers ## Safety & Disclaimers
⚠️ **Important Notes:** ⚠️ **Important Notes:**
- Always backup your save files before editing - Always backup your save files before editing
- Use at your own risk - save corruption is possible - Use at your own risk - save corruption is possible
- This tool is for educational and personal use only - This tool is for educational and personal use only
- Not affiliated with Bethesda Game Studios - Not affiliated with Bethesda Game Studios
## License ## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments ## Acknowledgments
- Bethesda Game Studios for Fallout Shelter - Bethesda Game Studios for Fallout Shelter
- The modding community for reverse engineering the save format - The modding community for reverse engineering the save format
- Electron.js team for the framework - Electron.js team for the framework
- Font Awesome for icons - Font Awesome for icons
## Support ## Support
If you encounter issues: If you encounter issues:
1. Check the [Issues](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/issues) page 1. Check the [Issues](https://gitea.serversyndicate.com/Bored/Fallout-Shelter-Save-Editor/issues) page
2. Create a new issue with detailed information 2. Create a new issue with detailed information
3. Include your operating system and save file details (without personal data) 3. Include your operating system and save file details (without personal data)
--- ---
**Enjoy modifying your vault! 🏠⚡** **Enjoy modifying your vault! 🏠⚡**