We could define "Equipment" as the set of files that define the units, campaigns and scenarios designed for those units,
as well as the graphical interface for its representation in the game.
Equipments (aka: Efile) thus include files for:
- The units properties (icon, unit name, type, movement, and stats)
- The interface (flags, map markers, leadrs portraits, ...)
- The text files to define custom game rules
- The Campaigns and scenarios files made for the equipment.
Equipments are located in specific folders (aka: EFolder) identified as having the SCENARIO sub-folder,
the equipment file (Equip.xeqp or Equip97.eqp for PG2 stuff) and the nations definitions (Nations.txt).
Files required by game are always searched first in the specific EFolder/sub-folders,
and then in main game folder/sub-folders. There is always one Equipment selected (active) in game, which is shown in main start window.
These are the sub-folders structure that can be set up in any EFolder
||All campaigns and scenarios made for the EFile should be put here
||Can hold standalone scenarios if you prefer to keep them on different folders, but not needed as game can find in SCENARIO as well.
||Game will create
||All savegames you do (manual or auto) will be placed here.
||To put specicf maps required for some scenarios (mostly used for development)
Most Efiles dont need to use this, and look maps in Main MAP folder
||This is the place to have a different UI appearance for this Equipment File.
Rest of files needed will be taken from Main OPENGUI folder
||Required to put nation's related graphics, like like flags, start screen, medals, dossier, portraits, ...
Only EFiles using same nations than PG2 can skip this folder.
Rest of common files will be taken from Main OPEDAT folder.
to include any
||The place to put custom music, not available or different than the music included in Main SOUND folder.
Most game effects are valid for any EFile
||The place to put units sound effects, when different than the standar included in Main SFX folder.
||The place to put videos defined in Campaigns/Scenarios. No needed if no custom videos required.
||Game will create
||Will include all .log files the game will create,like: ai_turn.txt, debug, and .XLOG files.
||Can include designers documents, as text, rtf or pdf
||Can be several sub-folders like this, if designer provided alternative texts for different languages.
?? being the ISO code of the country.
Installer creates same folders in Main game folder (except TEXT-ISO folders) and populate with default files, so any file required
and not found in the active EFolder can be loaded from Main folder.
When installing Open General over an existing installation og PG2, then the Main folder becomes also an EFolder for the PG2 equipment (Equip97.eqp)
Changing active equipment
When player wants to pick any file to play (campaign, Scnario or Savegame), from main menu,
he will only see the files within the EFolder's sub-folders.
You can always change the active EFile, by selecting a different one by clicking the top-left icon in main menu.
When picking a file to play from the Settings Recent file-list, the EFile will be changed automatically if needed,
and same when picking a file from the All-campaigns dialog.
At anytime the EFile is changed, all the files in memory are discarded and reloaded according the new active EFile.
Only these files/folders are strictly required to define an EFile:
- The Equipment roster: Equip.xeqp and Equip.txt
- The nations/sides text file: Nations.txt
- The SCENARIO sub-folder (even empty)
Rest of files and sub-folders are not strictly needed, although some of them are highly recommended:
- Files in EFolder (see also: See Config files)
||This file show EFile information when browsing to select/activate a new Efile.
||This file allows to change the colors used for UI. Not neded if you like default colors.
||This file has the names you will see in game for generals and leaders.
||This file allows to configure different terrain settings afecting movement and combat.
||This file includes customizez strings for EFile, like Targets, Results, Movements, Unit classes,...
||This file include customized data for climate zones
||This file include customized font to use for the Efile
||This file include alternative denominations (usually in original language) for units in EFile
||This file defines a diferent base-year (default is 1900) for the Efile.
||This file include labels for Fronts and Factions. It is not used by game
- Files in EFolder\OPENDAT (also defaults in Main OPENDAT)
|PNG files having the flags for the countries defined. Every Efile should include these files
|PNG files having the Campaign Dossier interface
|INSPECT_MEDAL / INSPECT_PORTRAIT
||PNG files including portraits of leaders. INSPECT_MEDAL is not used if INSPECT_PORTRAIT is present
||PNG file used for main start window when the Efile is active. File name can be any. as far as it start with "START_"
||PNG file used to signal units having a leader in map
Weather effects ... Usually only in Main OPENDAT folder
|PNG files for Rain/Snow animated effects in map.
- Files in EFolder\OPENGUI (also defaults in Main OPENGUI)
Cursors ... Usually only in Main OPENGUI folder
||.CUR files used to embark unit in ATP/NTP/RTP/HTP
||.CUR files used to disembark from ATP/NTP/RTP/HTP
||.CUR files used to Deploy, point/select, Not Alloed, BarrageFire and Combat or Bombard
||.CUR files used to signal than unit will mount if moving to the hex pointed
||.PNG files used to pop up dialogs showing unit details
||.PNG files used to show unit/transport stats in purchase/upgrade windows
||.PNG files used as background for other dialogs
||.PNG file used to select country in HQ/Purchase/Upgrade windows
||.PNG files used to draw into other dialogs/windows
|.PNG files used to draw menus in dialogs/windows
||.PNG files used to show menus
Misc info ...
||.PNG files used to show info in odialogs/windows or in Map
||.PNG files used to show info on map
|UnitMoves and UnitTargets|
|.PNG files used to show targets and movement methods. UnitIcons is deprecated, but it can be loaded yet.
||.PNG files used to animate explosions and units fire
||.PNG files used to show markers/terrain help on map
||.PNG files used to show road/rails marks on map
||.PNG files used to set up tiled maps
PG2 format files
When loading PG2 equipment/games, OpenGeneral reads PG2 standar files: Equip97.eqp,Equip97.txt,Gui97.txt,Misc.txt, and
.cam/.scn/ .sav/.csv (no .eml though) and converts internally to standard OpenGeneral formats.
When converting scenarios/savegames, the file Fronts.txt is checked and if not found, the scenario is set to
"Pg2Mode" (Pg2 compatibility mode), disabling any new feature.
Fronts.txt file is not actually loaded and it is really not needed to play, it is only used to know
if old formats come from PG2 of former releases of OpenGeneral