Update README.md

README.md

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