GORGON-EGG
Download
GORGON-EGG is a replacement for Fire Emblem: The Sacred Stones’ Panel setting unit window. It turns the vanilla window, which normally looks like this:
into something like this:
Errr… Yeah, maybe something more like this:
The window created by GORGON-EGG is easily configurable, allowing users to create anything from the massive panel shown above to mimicking the vanilla window exactly. The size and contents of the window are up to the user. No programming experience is needed in order to configure the window.
How do I use GORGON-EGG in a project?
GORGON-EGG is designed for use with an Event Assembler buildfile. It has a few prerequisite steps that must be completed before it can be used. The ‘Prerequisites’ section of the main README details these steps. After setting up the necessary tools, users can configure the window to their liking (see the section below) before building GORGON-EGG. After building, simply #include the output/Installer.event file in your buildfile.
How do I configure GORGON-EGG?
To customize your GORGON-EGG window, edit the config text file. This XML-formatted text file controls what kinds of elements appear on the window as well as controlling their appearance and behavior. Being just a text file allows for window configurations to be edited and shared freely, with little to no technical knowledge needed.
GORGON-EGG ships with many prepackaged options for users to pick from, such as a variety of window shapes and sizes, different extension/retraction styles, tools for drawing most unit statistics, and various ways to draw unit names.
There are example config files in the example folder.
Config content breakdown
A config file has its contents between exactly one set of <Config></Config> tags.
Adding functionality to the window is done with <Module> tags. A module is a bundle of code, graphics, data, etc. that adds some kind of feature to the window (such as displaying a number or graphic). <Module> tags have one attribute, Name, which is the name of the module to include.
Modules, which are located in the modules folder, have README files in their folders, which begin with the module’s name.
For example, to draw an HP bar (in the same style as the vanilla window’s bar) to the window one would add the following line to their config:
<Module Name="HPBarStandard"/>
Modules generally come with a set of default options for things like positions or style, and can be overridden within user config files.
Customizing the functionality of a module is typically done using <Definition> tags. A <Definition> tag normally has two attributes, Name and Value. If you wanted the HP bar in the example above to be as wide as the one on the vanilla window, your config would also have the following line:
<Definition Name="HPBAR_WIDTH" Value="7"/>
The main README has a section that goes into more detail about user configuration.
GORGON-EGG is missing something that I need. Can I add it myself?
Yes! In addition to being easily configured, GORGON-EGG is designed to be edited and extended.
Extending GORGON-EGG
GORGON-EGG includes a custom folder for user-supplied or -edited code. If you want to edit the functionality of prepackaged modules, simply place a copy of the module in the custom/modules folder and edit that, allowing you to make changes without overwriting the original module. When a config requests a module, it checks for custom modules before using ones found in the source folder. When writing fully-custom modules, they should also go in the custom folder. This way makes it easy to distribute custom and edited modules.
GORGON-EGG modules are written in C, but still provides tools for working with THUMB assembly, if users prefer. Modules are (nearly always) independent of one another and the underlying system, which allows users to drop in or remove modules without having to edit any non-module files.
The modules README file offers more information about the structure of modules.
Why should I use this over other Unit Window replacements?
GORGON-EGG has the following advantages over something like the Modular Minimug Box:
- Written in C
- Adding/removing modules is drag-and-drop
- Existing modules can be overridden without editing the original
- Smaller, simpler config files
How can I share my GORGON-EGG window?
For maximum portability, users should share their Config.xml file along with anything in their custom folder. It is possible, however, to package the entirety of the output folder after building and distribute that, although it is not recommended.
If you have a module or window configuration that you would like to see added to GORGON-EGG, or have a suggestion for one, please let me know!
