Skip to content

Getting Started

DameDizzman edited this page Aug 22, 2025 · 5 revisions

Getting Started with HGEngineGUI

This guide will walk you through installing, setting up, and starting to use HGEngineGUI for your Pokemon ROM hacking projects.

๐Ÿ“ฅ Installation

Option 1: MSIX Package (Recommended)

  1. Download the Release

    • Visit the GitHub Releases page
    • Download the latest .msix or .msixbundle file
    • Also download the accompanying .cer certificate file
  2. Install the Certificate

    • Double-click the .cer file
    • 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
  3. Install the Application

    • Double-click the .msix or .msixbundle file
    • Follow the installation prompts
    • The app will be installed and appear in your Start Menu
  4. Alternative Installation Script

    • If provided, run the included install.ps1 or install.bat script
    • This will automatically handle certificate installation and app deployment

Option 2: Build from Source

If you prefer to build from source or need development access:

  1. Prerequisites

    • Windows 10 version 2004 (19041) or newer
    • Visual Studio 2022 with:
      • .NET 8 SDK
      • UWP/WinAppSDK workloads
      • MSVC v143 build tools
  2. 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

๐ŸŽฏ Project Setup

1. Launch HGEngineGUI

  • Open HGEngineGUI from your Start Menu or desktop shortcut
  • The application will start on the Project page

2. Select Your HG Engine Project

  • 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

3. Verify Project Detection

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/data folder for changes

๐Ÿ—‚๏ธ Understanding Project Structure

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)

๐Ÿš€ First-Time Usage

Editing Pokemon Data

  1. 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
  2. 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
  3. 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

Editing Trainer Data

  1. Navigate to Trainers

    • Click the "Trainers" button in the navigation pane
    • The list shows all trainers with their class and party size
  2. 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

โšก File Monitoring

HGEngineGUI automatically monitors your project files for external changes:

  • Detection: Changes to files in armips/data are 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

๐Ÿ”ง Configuration

Keyboard Shortcuts

  • Ctrl+S - Save changes in editor pages

Settings and Preferences

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

๐Ÿ” Troubleshooting First Launch

"No Species Found"

  • Verify your project path is correct
  • Ensure include/constants/species.h exists and contains species definitions
  • Check that the file follows the expected format with #define SPECIES_* entries

"Empty Lists"

  • Confirm the expected data files exist in armips/data/
  • Check file permissions and read access
  • Verify file format matches HG Engine standards

"Installation Failed"

  • Ensure you have administrator privileges
  • Check that the certificate was installed correctly
  • Try the PowerShell installation script if available

๐Ÿ“š Next Steps

Now that you have HGEngineGUI set up, explore these sections:

๐Ÿ†˜ Getting Help

If you encounter issues:

  1. Check the Troubleshooting section
  2. Look through the FAQ
  3. Include your crash logs (found in app LocalState) when reporting issues
  4. Provide your Windows version and HGEngineGUI version number

Happy ROM hacking! ๐ŸŽฎ

HG Engine Editor Wiki Navigation

Quick Start

  1. Home
  2. Getting Started
  3. User Interface
  4. FAQ

Guides

Technical

Support

Clone this wiki locally