FF6LE Rogue CE / Zone Doctor CE

FF6LE Rogue CE
Version: 0.8.1
Release date: 01/08/2017
Download
GitHub Repository

Zone Doctor CE
Version: 0.2.2
Release date: 10/16/2016
Download
GitHub Repository

Warning
Zone Doctor does all what FF6LE does plus it has other modules for hex editing, event editing, graphics, projects, data import, etc. However, Zone Doctor can easily corrupt your ROM. This is the reason why few people use it. The level editor (FF6LE module) can easily corrupt the exit data. The event editor also has some bugs. This is why it is suggested to stick to hex editing for events. Zone Doctor never reached a final version, it is considered by many something to avoid for some tasks. Since no original Zone Doctor bug were fixed, it is recommended to use FF6LE Rogue CE instead if you want to have the expansion features.


FF6LE CE expand Tilemaps space, Tilemaps numbers, Location numbers, NPC, Event Triggers and Exits max space. It also allow to rename location names within the editor and Message names, the map names in-game as well as expanding them to 256 (instead of 73).There are now 511 tilemaps instead of 351 and 511 Locations instead of 415. The expansion require a byte set to 0xFF (you can choose) for ROM settings. By default the one selected is unused by the game. The expansion require 1 bank for NPCs, events, exits and treasures (which can be on the 511 locations but are not expanded in number) while tilemaps compressed data require 0x50000 to 0x70000 bytes instead of ~0x43000. You can basically choose between 5, 6 and 7. These banks need to be continuous but the data bank could be elsewhere.

If you were using FF6LE+ or Zone Doctor+, check the checkbox before doing the expansion because it will allow to skip the ASM validation. If you have a warning message after the validation, it is probably because you moved some code or already moved some data the editor is trying to move. The first scenario is a lot worst because the game will overwrite code with one or many garbage value (not a the right position). You can proceed but the ROM could have problems. If as an example for a reason you already have moved NPCs elsewhere and strictly edited corresponding ASM, the expansion should be done correctly. I'm thinking about leaving ASM validation optional but anyway valid or not you can perform the expansion.

When you do the expansion, a log (log.txt) is created in your editor folder. This is until I reach a stable release (1.0). If your ROM has problem you can post the log in this thread. It will greatly help me understand the problem if expansion is the source of the problem.

All the settings and locations names are saved in a XML file. You can change those settings via the file but I suggest to stick to changing location names. The rest can be done via the editor (location names too). For people coming from version 0.6, you have the possibility at startup to import your previous setting directly from the ROM and import the location names .bin file as well. This is not a concern for Zone Doctor as it starts with XML files.

The default L1 tilemap ID ($15F) on maps $19F to $1FF is shadow's dream (256x256 black map with layer 1 only). Tilemaps $15F to $1FF are all the same, they take $1A bytes of space each.  To make the map bigger, you select your new tilemaps ID(s) (L1, L2 and L3 if neccesary). Then you resize the layers (from 256x256 to 1024x1024 as an example) and set the other map properties. Then you can either import tilemaps (which should cover the correct layers sizes) or hand draw.

This version also correct vanilla FF6LE bugs notably the L2 and L3 Tilemap import bug, the exit ID bug, and the possible compression overflow on saving certain vanilla tilemaps that are rarely edited (experimental fix).



Special Thanks
B-Run for using CoV as a test subject for that project.
James White for extensively testing the CoV build.
Warrax for testing attentively the new builds.

Expansion ROM Map

Code:

DESCRIPTION     TYPE    OLD LOCATION    NEW LOCATION    
-----------     ----    -------------   -------------  
Events          PTR     C40000-C40341   C40000-C40401  
Events          DATA    C40342-C41A0F   C40402-C44401  
NPCs            PTR     C41A10-C41D51   YY0000-YY0401  
NPCs            DATA    C41D52-C46ABF   YY0402-YY8FFF  
Exits (small)   PTR     DFBB00-DFBF01   YY9000-YY9401  
Exits (small)   DATA    DFBF02-DFD9FF   YY9402-YYCFFF  
Exits (long)    PTR     EDF480-EDF881   YYD000-YYD401  
Exits (long)    DATA    EDF882-EDFDFF   YYD402-YYDFFF  
Treasures       PTR     ED82F4-ED8633   YYE000-YYE3FF  
Treasures       DATA    ED8634-ED8E5A   YYE400-YYF3FF  
Free Space      ----    -------------   YYF400-YYFFFF
Tilemaps        PTR     D9CD90-D9D1AF   D9CD90-D9D38D  
Tilemaps        DATA    D9D1B0-DDFFFF   XX0000-ZZFFFF  
Map Properties  DATA    ED8F00-EDC47F   DA0000-DA41DE  
Map Names       PTR     E68400-E6877F   DA4200-DA43FF
Map Names       DATA    CEF100-CEF5FF   DA4400-DA68FF

YY = Expanded Data bank
XX = Expanded Tilemaps starting bank
ZZ = XX + number of Expanded Tilemaps banks

* Could serve for extra treasure data once SRAM expanded.

Expansion ASM changes

Code:

;For reference only

;Assuming Expanded Data Banks is $50
;Assuming Expanded Tilemaps Data Starting Bank is $51

;MAP DATA
;--------
org $C01CBF
LDA $DA0000,X

;EVENTS
;------
org $C0BCAE    
LDA $C40002,X

org $C0BCB4    
LDA $C40000,X

org $C0BCBD    
LDA $C40000,X

org $C0BCD3    
LDA $C40002,X

org $C0BCED    
LDA $C40004,X

;NPCS
;----
org $C052BC    
LDA $500002,X  

org $C052C2    
LDA $500000,X  

org $C052D4    
LDA $500000,X

org $C052DB    
LDA $500001,X

org $C052E2    
LDA $500002,X

org $C052EB    
LDA $500002,X

org $C052F8    
LDA $500002,X

org $C05305    
LDA $500002,X

org $C05321    
LDA $500004,X

org $C0532C    
LDA $500004,X

org $C0533A    
LDA $500005,X

org $C0535A    
LDA $500005,X

org $C05369    
LDA $500006,X

org $C05373    
LDA $500007,X

org $C0537F    
LDA $500007,X

org $C0538A    
LDA $500007,X

org $C05397    
LDA $500008,X

org $C053AD    
LDA $500008,X

org $C053BC    
LDA $500008,X

org $C053D0    
LDA $500008,X

org $C053E3    
LDA $500008,X

;TREASURES
;---------
org $C04C08    
LDA $50E404,X

org $C04C0E    
LDA $50E402,X

org $C04BDA    
LDA $50E002,X

org $C04BE0    
LDA $50E000,X

org $C04BEC    
LDA $50E400,X

org $C04BF4    
LDA $50E401,X

org $C015DD    
LDA $50E002,X

org $C015E3    
LDA $50E000,X

org $C015F1    
LDA $50E400,X

org $C015F7    
LDA $50E401,X

org $C015FE    
LDA $50E402,X

org $C01609    
LDA $50E402,X

;LONG ENTRANCES
;--------------
org $C018EA    
LDA $50D002,X

org $C018F0    
LDA $50D000,X

org $C01903    
LDA $50D002,X

org $C0190B    
LDA $50D001,X

org $C01916    
SBC $50D000,X

org $C0191E    
LDA $50D000,X

org $C0192F    
LDA $50D000,X

org $C0193A    
SBC $50D001,X

org $C01942    
LDA $50D001,X

org $C01963    
LDA $50D003,X

org $C0196F    
LDA $50D003,X

org $C0197B    
LDA $50D003,X

org $C0198A    
LDA $50D005,X

org $C0199F    
LDA $50D005,X

org $C019A9    
LDA $50D004,X

org $C019B6    
LDA $50D004,X

org $C019C4    
LDA $50D004,X

org $C019E5    
LDA $50D003,X

org $C01A14    
LDA $50D004,X

;SHORT ENTRANCES
;---------------
org $C01A7D    
LDA $509002,X  

org $C01A83    
LDA $509000,X

org $C01A8F    
LDA $509000,X

org $C01AAA    
LDA $509002,X

org $C01AB6    
LDA $509002,X

org $C01AC2    
LDA $509002,X

org $C01AD1    
LDA $509004,X

org $C01AE6    
LDA $509004,X

org $C01AF0    
LDA $509003,X

org $C01AFD    
LDA $509003,X

org $C01B0B    
LDA $509003,X

org $C01B2C    
LDA $509002,X

org $C01B5E    
LDA $509003,X

org $EE20E9
LDA $509000,X
STA $58        
LDA $509002,X  

org $EE20FE
LDA $509000,X  

org $EE2106
LDA $509001,X

org $EE2110
LDA $509002,X

org $EE213C
LDA $509004,X

;TILEMAPS
;--------
org $C02892
LDA $D9CD90,X  
CLC
ADC #$0000

org $C0289F
LDA $D9CD92,X
ADC #$51

org $C028E6
LDA $D9CD90,X  
CLC
ADC #$0000

org $C028F3
LDA $D9CD92,X
ADC #$51

org $C0293C
LDA $D9CD90,X
CLC
ADC #$0000

org $C02949
LDA $D9CD92,X
ADC #$51

;MAP NAMES
;---------
org $C07FFD
LDA #$DA

org $C08008
LDA $DA4200,X
ADC #$4400

;CHEST MEMORY
;------------
org $C0BB1A
STZ $1E20,X

org $C0BB1E
CPX #$0060

org $C04C1A
AND #$03FF

org $C04C24
LDA $1E20,Y  

org $C04C2D
LDA $1E20,Y    

org $C04C34
STA $1E20,Y

org $C01602
AND #$03FF

org $C01614
LDA $1E20,Y   

Memory Byte flags (Deprecated)

Code:

Version 0.6 and below

0x01    5 banks of tilemap data
0x02    6 banks of tilemap data
0x03    7 banks of tilemap data
0x20    chest memory expansion
0x40    was using FF6LE+ or Zone Doctor+ before
0x80    map expansion