RPG Maker MV NW.js Automation Script

A Python script that completely automates the process of replacing RPG Maker MV/MZ game runtime with a modern NW.js installation, providing better performance, space savings, and developer tools access.

🎯 What This Script Does

This script transforms your RPG Maker games by replacing their outdated runtime with modern NW.js versions.

✨ Key Benefits

• 💾 Massive Space Savings: Save 100-120MB per game (one NW.js serves all games)
• 🛠️ Developer Tools: Press F12 for debugging, modding, and game analysis
• ⚡ Better Performance: Modern NW.js with latest bug fixes and optimizations
• 🎮 Custom Game Names: Create personalized executable names
• 🤖 Zero Manual Work: Fully automated with intelligent error handling
• 🔒 100% Safe: Creates backups and validates everything before changes
• 🌍 Cross-Platform: Works on Windows, macOS, and Linux

Automatic Processing

• Game Validation: Verifies the directory contains a valid RPG Maker MV/MZ game
• NW.js Download: Automatically downloads the specified NW.js version if not provided
• Runtime Cleanup: Intelligently removes NW.js runtime files while preserving game assets
• Configuration Updates: Modifies package.json with required fields for newer NW.js versions
• Launch Script Creation: Creates platform-specific launch scripts (.bat for Windows, .sh for Unix)

One-Click Solutions

• Intelligent Setup: Launch scripts automatically check and install dependencies
• Cross-Platform: Works seamlessly on Windows, macOS, and Linux
• Desktop Integration: Optional desktop shortcuts for instant access
• Zero Configuration: Works out-of-the-box with sensible defaults
• Visual Feedback: Colored terminal output with clear progress indicators

Safety Features

• Automatic Backup: Creates a backup of the original game before modifications
• File Preservation: Carefully preserves game assets, README files, and custom directories
• Error Handling: Comprehensive error handling with informative messages
• Validation: Multiple validation steps to ensure safe processing

💻 Ultra-Quick Setup (30 Seconds!)

🖱️ Method 1: One-Click Launch (Recommended)

1. Download the latest release from GitHub Releases
2. Extract anywhere convenient (Desktop, Tools folder, etc.)
3. Double-click the launcher for your system:
   • Windows: run_nwjs_automator_win.bat
   • Mac/Linux: run_nwjs_automator_unix_mac.sh

That's it! The launcher will:

• ✅ Check if Python is installed (with install guidance if needed)
• ✅ Automatically install required dependencies
• ✅ Offer to create desktop shortcuts
• ✅ Launch the automation tool
• ✅ Keep the terminal open to show results

Method 2: Command Line (For Advanced Users)

The script will guide you through everything with a user-friendly interface!

python nwjs_automator.py

📋 Requirements

• Python 3.6+ (script will check and guide you if needed)
• Internet connection (to download NW.js if not provided)
• Required packages (automatically installed): requests

💻 Installation

Step 1: Install Python (if needed)

• Windows: Download from python.org and check "Add to PATH"
• Mac: brew install python3 or download from python.org
• Linux: Usually pre-installed, or sudo apt install python3 python3-pip

Step 2: Install Dependencies

pip install requests

Step 3: Download Script

Download nwjs_automator.py from the releases page

🎮 How to Use

🌟 Interactive Mode (Easiest)

1. Run the script:

   python nwjs_automator.py

2. Follow the colorful prompts:

   • 📁 Game Path: Enter your RPG Maker game folder
   • 🎯 Game Name: Choose your custom executable name (e.g., "MyAwesomeGame")
   • 🔧 NW.js Version: Pick from optimized presets or go custom
   • 🛠️ Build Type: SDK (recommended) or Normal
   • 💾 Backup: Yes (recommended) or No

3. Sit back and watch: The script handles everything automatically!

🎯 NW.js Version Guide

The script offers smart version presets:

Option	Version	Best For	Windows Support
1	v0.29.4	Maximum compatibility (RPG Maker MV era)	Windows 7+
2	v0.49.2	Balanced default - best overall choice	Windows 7+
3	v0.72.0	Modern stable (last Win7 support)	Windows 7+
4	v0.90.0+	Latest features, best performance	Windows 10+
5	Custom	Specific version needs	Varies

💡 Recommendation: Use option 2 (v0.49.2) for the best balance of compatibility and performance.

🛠️ Build Types Explained

• SDK Build (Recommended):

  • ✅ Includes F12 Developer Tools
  • ✅ Perfect for modding and debugging
  • ✅ Only 5-10MB larger

• Normal Build:

  • ✅ Slightly smaller size
  • ❌ No developer tools
  • ⚠️ Use only if you need absolute minimum size

🔧 Advanced Usage

Command Line Options

# Basic usage
python nwjs_automator.py --game-path "C:\Your\Game"

# Custom executable name
python nwjs_automator.py --game-path "C:\Your\Game" --executable-name "MyGame"

# Specific NW.js version
python nwjs_automator.py --game-path "C:\Your\Game" --nwjs-version "v0.72.0"

# Use existing NW.js installation
python nwjs_automator.py --game-path "C:\Your\Game" --nwjs-path "C:\nwjs"

# Skip backup (not recommended)
python nwjs_automator.py --game-path "C:\Your\Game" --no-backup

# Normal build instead of SDK
python nwjs_automator.py --game-path "C:\Your\Game" --no-sdk

# Verbose logging
python nwjs_automator.py --game-path "C:\Your\Game" --verbose

All Command Line Arguments

Argument	Description	Default
--game-path	Path to RPG Maker game directory	Required
--executable-name	Custom name for game executable	"Game"
--nwjs-path	Path to existing NW.js installation	Auto-download
--nwjs-version	NW.js version to use	"v0.49.2"
--no-sdk	Use normal build instead of SDK	SDK build
--no-backup	Skip creating backup	Create backup
--verbose, -v	Enable detailed logging	Normal logging
--interactive, -i	Force interactive mode	Auto-detect

🔄 What the Script Does (Step by Step)

1. 🔍 Validation Phase

• ✅ Checks if directory contains valid RPG Maker MV/MZ game
• ✅ Verifies package.json and www/ folder exist
• ✅ Validates and fixes package.json for NW.js compatibility
• ✅ Ensures all critical files are present

2. 💾 Safety Phase

• ✅ Creates complete backup as GameName_backup
• ✅ Backs up critical files (package.json, www/, index.html)
• ✅ Validates backup integrity before proceeding

3. 📥 NW.js Setup Phase

• ✅ Downloads specified NW.js version (if not provided)
• ✅ Extracts and prepares NW.js runtime
• ✅ Chooses correct architecture (x64, x86, ARM) automatically

4. 🧹 Cleanup Phase

• ✅ Removes old NW.js runtime files from game
• ✅ Preserves all game assets and custom files
• ✅ Cleans up unnecessary files (chromedriver, docs, etc.)
• ✅ Keeps only essential locale files (en-US)

5. 🔧 Integration Phase

• ✅ Copies new NW.js runtime to game directory
• ✅ Restores game files with proper structure
• ✅ Creates/fixes index.html if missing
• ✅ Renames executable to your custom name

6. ✨ Finishing Phase

• ✅ Removes unnecessary NW.js files
• ✅ Creates Windows shortcuts (if applicable)
• ✅ Sets proper file permissions
• ✅ Validates final game structure

📁 Before & After

Before Processing

YourGame/                          (~120MB)
├── Game.exe                       (NW.js runtime)
├── nw.dll, ffmpeg.dll, etc.       (Runtime files)
├── resources.pak                  (NW.js resources)
├── locales/                       (All languages)
├── www/                           (Your game!)
└── package.json                   (Game config)

After Processing

YourGame/                          (~5-15MB)
├── YourCustomName.exe             (Your named executable)
├── www/                           (Your game - preserved)
├── package.json                   (Updated & optimized)
├── index.html                     (Validated/created)
└── YourCustomName.lnk             (Windows shortcut)

YourGame_backup/                   (~120MB)
└── [Complete original backup]

🛠️ Developer Tools Access

With SDK build (default), press F12 in your game for:

🔧 Debugging Features

• Console: Execute JavaScript commands directly
• Elements: Inspect game DOM structure
• Sources: Debug game scripts with breakpoints
• Network: Monitor resource loading
• Performance: Profile game performance

🎮 Game Modification Examples

// In the game console (F12):

// Check NW.js version
process.versions

// Increase save slots
DataManager.maxSavefiles = () => 99

// Modify player stats
$gamePlayer.gainGold(99999)
$gameActors.actor(1).gainExp(999999)

// Skip events or change switches
$gameSwitches.setValue(1, true)
$gameVariables.setValue(1, 100)

// Test battles
$gameParty.addActor(2)
SceneManager.push(Scene_Battle)

🌟 Special Features

🔄 Automatic index.html Handling

• Smart Detection: Finds and preserves existing index.html
• Intelligent Creation: Creates optimized index.html if missing
• Script Auto-Discovery: Automatically includes all game scripts in correct order
• Library Order: Maintains proper RPG Maker MV library loading sequence

📦 Smart package.json Fixes

• Name Field: Adds required name field for newer NW.js versions
• UTF-8 Encoding: Ensures proper character encoding
• Validation: Checks JSON syntax and structure
• Backup: Preserves original configuration while adding required fields

🗂️ Intelligent File Preservation

The script carefully preserves:

• ✅ All game assets (www/ folder)
• ✅ Custom README files (.txt, .md, .pdf)
• ✅ User-created directories
• ✅ Save files and configuration
• ✅ Plugin data and custom resources

🧹 Smart Cleanup

Removes only unnecessary files:

• ❌ chromedriver.exe (development tool)
• ❌ Documentation files (AUTHORS, CHANGELOG.md, etc.)
• ❌ Unused PAK files (nw_100_percent.pak, etc.)
• ❌ Extra locale files (keeps only en-US)
• ❌ SDK-specific files (if using normal build)

⚠️ Important Notes

🎮 Game Compatibility

• RPG Maker MV: Works with all versions (use v0.29.4 for maximum compatibility)
• RPG Maker MZ: Use v0.49.2 or newer
• Encrypted Games: May not work with DRM-protected games
• Custom Plugins: Most work fine, some may need specific NW.js versions

💾 File Organization Tips

📁 C:\RPG Games\
├── 📁 Game1\                    # Processed (5MB)
├── 📁 Game1_backup\             # Original backup (120MB)
├── 📁 Game2\                    # Processed (8MB)
├── 📁 Game2_backup\             # Original backup (135MB)
└── ...

📁 C:\Tools\
└── 📁 nwjs_automator\           # Keep script here
    ├── nwjs_automator.py
    └── temp_nwjs\               # Auto-created temp folder

🔒 Safety Reminders

• Always backup: Script creates backups automatically, but keep your own too
• Test games: Launch processed games once to ensure they work
• Save early saves: Keep save files from before processing
• Document versions: Note which NW.js version works best for each game

🐛 Troubleshooting

Common Issues & Solutions

❌ "package.json not found"

• ✅ Make sure you're pointing to the game's root directory
• ✅ Directory should contain both package.json and www/ folder

❌ "Python not found"

• ✅ Install Python 3.6+ from python.org
• ✅ On Windows, check "Add to PATH" during installation
• ✅ Restart command prompt after installation

❌ "Failed to download NW.js"

• ✅ Check internet connection
• ✅ Try a different NW.js version
• ✅ Use --nwjs-path to point to existing NW.js installation

❌ "Game won't start after processing"

• ✅ Try older NW.js version (v0.29.4 for maximum compatibility)
• ✅ Restore from backup and try with --no-sdk flag
• ✅ Check if game has custom plugins requiring specific versions

❌ "Permission denied" (Linux/Mac)

• ✅ Run with sudo if needed
• ✅ Make sure you have write permissions to game directory
• ✅ Check file ownership with ls -la

❌ "Missing dependencies"

• ✅ Install with: pip install requests
• ✅ On some systems: pip3 install requests
• ✅ Try: python -m pip install requests

🔧 Debug Mode

For detailed troubleshooting, use verbose mode:

python nwjs_automator.py --verbose --game-path "C:\Your\Game"

This shows detailed logs of every operation, perfect for diagnosing issues.

🆘 Getting Help

If you're still having issues:

1. Check the backup: You can always restore from GameName_backup
2. Try interactive mode: More user-friendly than command line
3. Use verbose logging: --verbose shows detailed error information
4. Test with different versions: Some games work better with specific NW.js versions
5. Check GitHub Issues: Someone might have had the same problem

🎯 Pro Tips

🚀 Performance Optimization

• Use SDK build unless you absolutely need smaller size
• Choose v0.49.2 for best balance of features and compatibility
• Process multiple games - they'll all share the same NW.js runtime
• Keep backups - you can always try different NW.js versions

🎮 Game Development Tips

• Use F12 tools to debug and test your games
• Test save/load functionality after processing
• Check plugin compatibility with your chosen NW.js version
• Document your settings - note what works for each game

💾 Storage Management

• One NW.js for all: All processed games share the same runtime
• Clean up temp files: Script does this automatically
• Organize backups: Keep original backups for safety
• Monitor space savings: You'll save 100MB+ per game processed

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

What this means:

• ✅ Free to use for personal and commercial projects
• ✅ Modify and redistribute as needed
• ✅ Include in your own tools without restrictions
• ⚠️ Attribution required (keep the copyright notice)

🙏 Credits & Acknowledgments

• Original Guide: Based on the excellent tutorial by Fairy's Voice
• NW.js Project: https://nwjs.io/ - The amazing runtime that makes this possible
• RPG Maker Community: For testing, feedback, and compatibility reports
• Python Community: For the incredible tools and libraries that power this script

🔄 Version History

v2.0.1 - Complete Rewrite (Current)

• 🪳 Fixed: Indentation error on line 460-462 (thanks to T1MM5H for reporting the issue)
• 🪳 Fixed: Os specific scripts and error handling improved

v2.0.0 - Complete Rewrite (Current)

• ✨ New: Completely redesigned interactive experience
• ✨ New: Smart NW.js version presets with compatibility guidance
• ✨ New: Automatic index.html creation and validation
• ✨ New: Intelligent package.json fixing for newer NW.js versions
• ✨ New: Custom executable naming with automatic extension handling
• ✨ New: Cross-platform shortcut creation (Windows .lnk files)
• ✨ New: Advanced file preservation logic
• ✨ New: Comprehensive error handling and validation
• ✨ New: Detailed progress reporting with colored output
• ✨ New: Support for multiple NW.js architectures (x64, x86, ARM)
• 🔧 Improved: Much more robust file handling and safety checks
• 🔧 Improved: Better cleanup of unnecessary NW.js files
• 🔧 Improved: Enhanced backup and restore system
• 🔧 Improved: Smarter temporary file management
• 🔧 Improved: Platform-specific optimizations
• 🔧 Improved: More informative logging and user feedback

v1.1.0 - One-Click Revolution

• ✨ New: Intelligent one-click launcher scripts
• ✨ New: Automatic dependency installation
• ✨ New: Desktop shortcut creation
• 🔧 Improved: Cross-platform compatibility

v1.0.0 - Initial Release

• ✨ New: Full automation of NW.js replacement process
• ✨ New: Interactive and command-line modes
• ✨ New: Automatic backup system
• ✨ New: Cross-platform support

🤝 Contributing

We welcome contributions from the RPG Maker community!

Ways to Help:

• 🐛 Report Bugs: Found an issue? Let us know!
• 💡 Suggest Features: Have ideas for improvements?
• 🔧 Submit Code: Pull requests are welcome
• 📖 Improve Docs: Help make the documentation even clearer
• 🎮 Test Games: Try the script with different games and report compatibility
• 🌍 Translate: Help translate the script for international users

Development Setup:

git clone https://github.com/aeagisdev/rpgm-nwjs-automator.git
cd rpgm-nwjs-automator
pip install -r requirements.txt

🌟 Show Your Support

If this tool helped you, consider:

• ⭐ Star the repository on GitHub
• 🐦 Share on social media - help other RPG Maker developers discover this tool
• 💬 Join discussions - share your experiences and help others
• 🎮 Report compatibility - let us know which games work great
• 📝 Write reviews - help spread the word about the benefits

📞 Support & Community

• GitHub Issues: Report bugs and request features
• Discussions: Ask questions and share experiences
• Wiki: Community compatibility database

---

Made with ❤️ by RPG Maker developers, for RPG Maker developers.

Transform your games. Save space. Unlock potential.