Getting Started

Getting Started

Concise setup for installing, opening a project, and making your first edits.

Download the latest version from here. (Download the .rar)

Install

• Recommended: run provided installer (install.bat) if available.
• Manual:
  1. Download .msix or .msixbundle (and .cer if provided)
  2. Install certificate to Trusted People (and Trusted Root if needed)
  3. Double‑click the package to install

Prerequisites:

• Windows 10 version 2004 (19041)+
• HG Engine with armips/, data/, include/

Build from source (optional): Visual Studio 2022, .NET 8, WinAppSDK workloads. Or CLI:

 dotnet build HGEngineGUI\HGEngineGUI.csproj -c Debug -p:Platform=x64 -r win-x64

Open your project

1. Launch the app → Project page
2. Pick Folder → select your HG Engine root (contains armips/, data/, include/)
3. Verify detection:
   • Status bar shows project path and species count
   • Species/Trainers/Moves/Encounters/Items/Config become enabled
   • File watcher starts (you’ll get reload prompts on external changes)

Project layout reference:

armips/ data: mondata.s, levelupdata.s, evodata.s, eggmoves.s, tmlearnset.txt,
             tutordata.txt, encounters.s, headbutt.s, trainers/trainers.s
armips/asm/custom: mart_items.s (optional addon)
data/: BaseExperienceTable.c, HiddenAbilityTable.c, itemdata/itemdata.c
include/: config.h, constants/{species.h,moves.h,abilities.h,item.h,trainerclass.h}, battle.h

First edits

• Species: Overview → change stats/types/abilities/etc. → Preview → Save
• TM/HM, Tutor: search/select → Preview → Save
• Trainers: select trainer → edit party (moves, IVs/EVs, items, nature, form, shiny lock, PP, nickname) → Preview → Save
• Moves: edit move core fields in Moves page → Preview → Save
• Encounters: pick route → edit grass/water/fishing, rates and probabilities → Preview → Save
• Items: adjust price; if mart_items.s exists, edit shops or General Poké Mart table → Preview → Save
• Config: toggle features (Fairy Type, Level Cap) → Preview → Save to include/config.h

Tips

• Ctrl+S saves on editor pages
• App prompts to reload when external changes are detected
• Preview shows exact diffs; backups (.bak) are automatic

Updates & uninstall

• Updating: install the newer .msix over the existing install
• Uninstall: Settings → Apps → HGEngineGUI → Uninstall

If something’s off

• Empty lists or “No Species Found”: verify project path and required files; include/constants/species.h must have #define SPECIES_*
• Install/packaging issues: ensure cert installed; use explicit Platform/RID when building
• Crash logs: check LocalState (last_crash.txt, first_chance.log) when reporting issues