Skip to content

GBE Manifest Files

Jump to bottom Edit New page
D. S. Baxter edited this page Apr 8, 2016 · 8 revisions

GB Enhanced+ Manifests

Manifests describe what files GBE+ needs to load when using Custom Graphics (CGFX). The manifest basically acts like a detailed list, pointing the emulator to the correct images. Entries within the manifest may also provide additional information on how to process the images. The primary advantage of manifests is that it reduces the time it takes for GBE+ to search for the correct CGFX assets and it gives users greater flexibility for their projects.

Manifests allow the user to associate a hash with any file name they want. Even a relatively simple looking tile like this:

could end up having a complex hash like this:

0630_07507J05X04T05X07J07503-

That's not very descriptive, and it's hard for most people to remember. Manifests allow GBE+ to associate that hash with a simpler name like "X_FONT.BMP" or whatever users want, as long as that name points to a valid image file. The format of manifest files is simple. Each entry is enclosed in brackets ([ ]), and each parameter is separated by a colon (:). Each entry has 5 parameters which are described below.

  1. GBE+ hash - This is the hash GBE+ computes (obtained while dumping graphics), such as "0630_07507J05X04T05X07J07503-"

  2. Image file name - This is the file name for the image associated with the above hash. Use a path relative to GBE+'s data folder. Enclose path in single-quotes!

  3. Image type - This determines what type of image the file represents. 1 = DMG Sprite, 2 = GBC Sprite, 10 = DMG Background Tile, 20 = GBC Background Tile.

  4. EXT_VRAM_ADDR - The address of a tile in VRAM, necessary for CGFX under certain scenarios. GBE+ will generate this. If uncertain, set to 0!

  5. EXT_AUTO_BRIGHT - Setting this to 1 will let GBE+ automatically correct the brightness of CGFX to match the original game's brightness. If uncertain, set to 0!

A working manifest file would look something like this:

#Comments look like this
#Font stuff below, pulling data from our Font folder, these are sprites btw
#The CGFX folder is in GBE+'s "data" folder
[07507J05X04T05X07J07503-:'CGFX\Font\X.bmp':1:0:0]
[07X07507507X07507507503-:'CGFX\Font\R.bmp':1:0:0]
[05X07506-05X04507505X03-:'CGFX\Font\S.bmp':1:0:0]

#You can even divide up graphics into your own categories for easier editing!
#Imagine we're loading Mario sprites or something here
[10102128173--1312123211:'CGFX\Mario\M_1.bmp':1:0:0]
[101053232223--333123211:'CGFX\Mario\M_2.bmp':1:0:0]
Add a custom footer
Add a custom sidebar
Clone this wiki locally