Repository navigation
Getting Started
This guide will walk you through installing, setting up, and starting to use HGEngineGUI for your Pokemon ROM hacking projects.
-
Download the Release
- Visit the GitHub Releases page
- Download the latest
.msixor.msixbundlefile - Also download the accompanying
.cercertificate file
-
Install the Certificate
- Double-click the
.cerfile - Click "Install Certificate"
- Choose "Local Machine" and click "Next"
- Select "Place all certificates in the following store"
- Browse to "Trusted People" and click "OK"
- Repeat the process for "Trusted Root Certification Authorities" store if required
- Double-click the
-
Install the Application
- Double-click the
.msixor.msixbundlefile - Follow the installation prompts
- The app will be installed and appear in your Start Menu
- Double-click the
-
Alternative Installation Script
- If provided, run the included
install.ps1orinstall.batscript - This will automatically handle certificate installation and app deployment
- If provided, run the included
If you prefer to build from source or need development access:
-
Prerequisites
- Windows 10 version 2004 (19041) or newer
- Visual Studio 2022 with:
- .NET 8 SDK
- UWP/WinAppSDK workloads
- MSVC v143 build tools
-
Clone and Build
git clone https://github.com/your-repo/HGEngineGUI.git cd HGEngineGUI open HGEngineGUI.sln- Set your configuration (Debug/Release, x86/x64/ARM64)
- Build the solution
- Run or deploy the application
- Open HGEngineGUI from your Start Menu or desktop shortcut
- The application will start on the Project page
- Click the "Pick Folder" button on the Project page
- Navigate to and select your HG Engine root directory
- The root folder should contain:
-
armips/- Assembly data files -
data/- Game data files -
include/- Header files - Other project-specific directories
-
After selecting your project folder, HGEngineGUI will:
- โ Display the project path in the status bar
- โ Show the number of detected Pokemon species
- โ Enable the Species and Trainers navigation buttons
- โ
Start monitoring the
armips/datafolder for changes
HGEngineGUI expects your HG Engine project to follow this structure:
Your-Project-Root/
โโโ armips/
โ โโโ data/
โ โ โโโ mondata.s # Pokemon species data
โ โ โโโ levelupdata.s # Level-up moves
โ โ โโโ evodata.s # Evolution data
โ โ โโโ eggmoves.s # Egg moves
โ โ โโโ tmlearnset.txt # TM/HM compatibility
โ โ โโโ tutordata.txt # Move tutor data
โ โ โโโ trainers/
โ โ โโโ trainers.s # Trainer data
โ โโโ include/
โ โโโ constants.s # Assembly constants
โโโ data/
โ โโโ BaseExperienceTable.c # Base experience values
โ โโโ HiddenAbilityTable.c # Hidden abilities
โโโ include/
โ โโโ constants/
โ โ โโโ species.h # Pokemon species definitions
โ โ โโโ moves.h # Move definitions
โ โ โโโ abilities.h # Ability definitions
โ โ โโโ item.h # Item definitions
โ โ โโโ trainerclass.h # Trainer class definitions
โ โ โโโ *.h # Other header files
โ โโโ battle.h # Battle-related constants
โโโ ... (other project files)
-
Navigate to Species
- Click the "Species" button in the navigation pane
- Browse or search for a Pokemon species
- Click on a species to open the detail editor
-
Make Your First Edit
- Go to the "Overview" tab
- Try changing a Pokemon's base stats (HP, Attack, etc.)
- Click "Preview" to see the changes
- Review the file modifications in the preview dialog
- Click "Save" to apply the changes
-
Explore Other Features
- Check the "TM/HM" tab for move compatibility
- Visit the "Tutor Moves" tab for move tutor settings
- View "Level-up", "Evolutions", and "Egg Moves" sections
-
Navigate to Trainers
- Click the "Trainers" button in the navigation pane
- The list shows all trainers with their class and party size
-
Edit a Trainer
- Select a trainer from the list
- Modify trainer details, class, AI flags, items, etc.
- Edit individual Pokemon in their party
- Use "Preview" and "Save" to apply changes
HGEngineGUI automatically monitors your project files for external changes:
-
Detection: Changes to files in
armips/dataare detected in real-time - Notification: You'll see a dialog asking if you want to reload data
- Choice: You can reload to get the latest changes or ignore them
- Safety: Your unsaved edits are preserved when reloading
-
Ctrl+S- Save changes in editor pages
Currently, HGEngineGUI uses sensible defaults for all operations. Future versions may include:
- Custom file path mappings
- UI theme preferences
- Auto-save intervals
- Backup retention settings
- Verify your project path is correct
- Ensure
include/constants/species.hexists and contains species definitions - Check that the file follows the expected format with
#define SPECIES_*entries
- Confirm the expected data files exist in
armips/data/ - Check file permissions and read access
- Verify file format matches HG Engine standards
- Ensure you have administrator privileges
- Check that the certificate was installed correctly
- Try the PowerShell installation script if available
Now that you have HGEngineGUI set up, explore these sections:
- User Interface Guide - Learn about all UI elements
- Species Editing - Master Pokemon data editing
- Data Mapping - Understand file structures
- FAQ - Get answers to common questions
If you encounter issues:
- Check the Troubleshooting section
- Look through the FAQ
- Include your crash logs (found in app LocalState) when reporting issues
- Provide your Windows version and HGEngineGUI version number
Happy ROM hacking! ๐ฎ