wario-land / wl4editor

Wario Land 4 Level Editor.

WL4Editor

This repository contains the most feature complete Wario Land 4 Editor yet.

Based on old and deprecated projects, we made a new one and are trying to make it the best one possible.

Download: Releases

If you're interested in our project and want to get the latest news and enjoy Wario Land hacking, you can join our Discord server with the link down below. You can not only share levels there, but also in the website. You can also see what levels other people have made using the editor on the website (also below).

Useful links

• Discord
• Level sharing website
• Toge-Docs

wl4editor's Issues

Re-saving with the Patch Manager causes "P" hooks to continually get longer

• Open a ROM
• Open the Patch Manager
• Press the "Add" button
• Press Browse and select a C patch file* which includes the "P" signifier in the Hook
• Press OK, then Save
• Open the Patch Manager again. The Hook is now (correctly) 4 bytes longer. If you press Edit, you can see that it comes after the "P".
• Save the Patch Manager, then Open it again. Notice that the Hook is 4 bytes longer.
• Repeat the previous step any number of times; the Hook will continue to grow.

*Here is an example of a file which will generate the problem: https://hatebin.com/cbbiomfryi

Open a second rom will make the editor unstable and crash or cause corruption in the rom file

Support sprite priority elevation in Room Configuration Dialog within pre Layer priority settings combo box

wrong max number settings for adding new foreground tiles into the Tileset in the Tileset editor

Patch feature causes game to crash if the code is optimized with stdlib calls

If the patch code would cause GCC to compile a function with several local variables, then building the stack frame is optimized with bl memcpy. The address of the memcpy symbol is unknown by the assembler but it compiles the code anyway, and the resulting binary crashes the game.

Suggested solution is to populate the assembly with a symbol for memcpy, or disable this specific optimization.

Repro:

• Open vanilla ROM
• Add the attached patch file "BoardReact.c" BoardReact2.zip
• Save
• Set breakpoint in No$gba to 0878F97C
• Go to the Big Board, and land the roulette on a Wario space
• Observe that 0878F986 branches to itself, causing a softlock (bl #0x878F986)

If someone is crazy enough to defragment the save chunks then you can try

Door config dialog preview graphicviews cannot set the scrollbars to the correct place when Layer 0's size is bigger than other layers

Seperate RomUtils::SaveFile() into 2 functions, one only changes the unsigned char *RomUtils::CurrentFile, another one save the CurrentFile data to file on the disk

the patch feature does not support save as, this is a solution.

Fix spinbox theme problem when showing warning in Room Config Dialog

When setting the Room size too big, the editor will make the 2 spinboxes there turn red, but without using the phantomstyle theme.

If someone is crazy enough to reuse data area before 0x78F970 and put RATS tag things there then you can try

Corruption when adding new room

beco: seems like adding new room corrupts the rom if it's already edited before. i tried to add a room in my hack but it made the rom unopenable with the editor, also got the same result with your hack (HW).

layer 0 alpha blending cannot be rendered correctly in the editor on transparent pixels

according to the gbatek documentations:
the top-most non-transparent pixel must be selected as 1st Target, and the next-lower non-transparent pixel must be selected as 2nd Target, if so - and only if so, then color intensities of 1st and 2nd Target are mixed together by using the parameters in BLDALPHA register.

so we should disable alpha blending for pixels if pixels in either layers are transparent.

Patch feature causes game to crash if gcc compiles a jump table

If the patch code would cause GCC to compile a jump table, then that code will crash the ROM. This reason is twofold; one is that the jumptable entries have addresses in ARM format, and the second is that the .s file is not assembled with a .org directive to specify the code's starting address.

Suggested solution for first issue unknown

Suggested solution for second issue is to emit a .org assembly directive when compiling the source code file.

Repro:

• Open vanilla ROM
• Add the attached patch file "BoardReact.c" BoardReact1.zip
• Save
• Set breakpoint in No$gba to 0878F97C
• Go to the Big Board, and land the roulette on a Wario space
• Observe that 0878F98C loads PC with an invalid jumptable address (mov r15, r3)

Latest Beta-8 not launching

WL4Editor.ini

We would like to be able to save particular settings in an ini file. These would include:

• The last file which was opened by the editor
• The location of the arm-none-eabi installation
  Programming would include high level functions in a static utility class to read or write key-value pairs with WL4Editor.ini in some format.

Undo and redo have not supported several editing

1. All Door changes;
2. All Entity changes;
3. Layer swapping and clearing;
4. Camera settings changes;
5. Level settings changes.

Select a Door will change the Door's position

happens when mouse release, door's X1 and Y1 are set to mouse position

Cannot get the correct Tile16 number of the last Tile16 in layers from the script interface

use interface.log(interface.GetCurRoomTile16(1, RoomWidth, RoomHeight)); in the js script always get 0xFFFF as a result.

Initial framework support for other languages

QT allows support for other languages using the i18n framework and placing translatable string constants in tr() or QT_TR_NOOP() symbols. Significant work will need to be done to the existing code before any translation work can start:

• We must place translatable strings within member functions in tr()
• We must place translatable strings within a static context in QT_TR_NOOP()
• Anywhere that a string is built through operator overloading, such as QString("The value is: ") + val, we need to parameterize the string so that no manual construction is being done
• We must set up the infrastructure to produce the actual translations

Once this item is closed, we can create a separate issue for each additional language, and assign them each to someone for whom it is their native language.

Undo and Redo cannot work for entity and door changes

the title says everything and there is a lot of things need to do to fix it:
1). the Door class needs some reimplementation since the current door destination finding code is bad
2). the current Door class make it hard to implement Undo and Redo, and also it affect the undo and redo of spriteset and sprites.

so basically 2 things:
1). re-implement the door class
2). add the code to support undo & redo of doors and sprites changes in Operation class. The door changes should be in the global operation queue, the sprite changes should be in the room operation queue.

Alpha layer will always be enabled when switch to a different Room with layer 0 turning off

if the first room and the second room both use alpha-blend features, then off layer 0 in the first room will disable the alpha layer automatically, but switch to the second room will set alpha layer enabled but layer 0 disabled

Change Tileset in Room Config Dialog will set checkbox value and enable Layer 2 and BG Layer, this should not happen

use setEnabled(true) instead of setCheck(true).

Find a method to support searching Entity in the Door Config Dialog

Idk if we really need to do this, i just put it here, since a single enemy can have different names, and the UI logic has to be edited in the code, not some easy property things, so i don't want to do it by myself.
There is another problem that in the future, people will perhaps inserting their own enemies, and we will support spriteset slot editing in the future, and the old of this will need more modifications.

The output widget resizes when text is changed in the window's footer

The output dock widget will automatically resize itself to the default size if the text at the bottom of the main window is modified.

This will not happen if you undock and redock the widget.

Support editing and saving mapping type 0x2X layers using background tiles

some extra ideas:
we should support editing layers using not-in-the-rom tileset too, so users can make some cutscenes by themselves using patch.
support exporting raw, RLE compressed, Lz77 compressed layer data so we can use them in patches.

Support hiragana/katakana for level names in JP ROM

Auto-scroll cannot function well when Layer0 has a different size compared to Layer 1, in Door Config Dialog

Title says everything.

Layer 0 editing becomes buggy again when it has a different size comparing to Layer 1 in beta-10

Flag reset incorrect after setting Layer 0 autoscroll in Room Config Dialog

Using a Toxic Landfill Tileset to make some Room using Tile8x8 Layer0, set L0 antuscroll in the dialog and hit Okay to save changes.
configParams.Layer0MappingTypeParam is set to 22, but it should be 0x22.

in Room Config Dialog, ComboBox_BGLayerPicker does not load all the existing available background correctly

it only load the current one into the combobox selection, but not all of them.

Animated tiles graphic won't change ingame after changing global switches values

There are 2 animated tileset slot lists for each Tileset, not one !!!

status bar disappears

The status bar will disappear if your screen's height cannot hold both output window and status bar when you switch to camera editing mode and the tall camera settings dock widget squashes the output window down.

Allow save chunks to be larger than 0xFFFF in size

This will be needed for some types of really large layers if someone has a 0xFF by 0xFF room, or if we allow people to import sound samples sometime way in the future.

This can be achieved by using one of the reserved bytes of the RATS tag to indicate that an additional 0x10000 should be added to the chunk size.

Changing Layer 0 Mapping Type to Tile8x8 related value will crash the editor

• Open a ROM
• Load Level: Sapphire Passage - Third Level (Fiery Cavern)
• Switch to Room 2
• Open Room Config
• Change Layer 0 Mapping Type to "0"(Disabled) from "22"(Tile8x8 & autoscroll)
• Press OK (close Room Config)
• Open Room Config
• Change Layer 0 Mapping Type to "22"(Tile8x8 & autoscroll) from "0"(Disabled)
• Press OK (close Room Config)
• The editor crashes

Map16 tile selector bug when changing rooms

When changing rooms or levels, the selected tile in the map16 selector changes to tile 0, and the previous tile you had selected cannot be selected again. You can select it if you choose another tile first.

• Open ROM
• Select tile 10 (the small block)
• Press the next room button
• Observe that tile 0 is now selected (not a bug by itself)
• Click tile 10 (the small block)
• Observe that it cannot be selected (bug)
• Click some other tile, such as tile 8 (blue gem)
• Click tile 10
• Observe that tile 10 can now be selected again

make some changes on camera limitator and hit save, then do some other changes on camera limitator and hit save again cause save failure

There is no data corruption directly on the rom, i mean the game can run without crash and the editor can load the rom.
Save failure will happen again after you closing the editor and open the rom in another editor, change the camera limitator and hit save.
It should be caused by chunk invalidation code, perhaps the pointer reset is fine.

Support multiple hooks in one patch

we discuessed about a possible feature (deprecated) when implementing the patch things that people only want to replace a pointer from some function pointer table, so they can completely replace a funciton but no need to change the vanilla code by injection. and gsb said it is possible that there are more than one pointers in the whole rom they need to replace.
so to do this, we can let users be able to add multiple hook addresses, and apply the same hook into different places, they can choose only to put a P in the hook string and do the multiple replacement.
you only need to change that int in the structure to some QString, and add a big loop in the patch application code to do the multiple hook for a same function (perhaps in patch withdraw part too)

Making changes on Camera setting will crash the editor (related to #230)

Repro:

• Open a ROM
• Select "Camera"
• Change camera setting to "Use Camera Limitators"
• Click "+" to add a camera limitator
• Save ROM
• Click "-" to remove a camera limitator
• Save ROM
• Change camera setting to "Follow Wario"
• Save ROM
• The editor crashes

blank Layer render problem

background layers will have weird things from other Rooms' layers or even non-map layers sometimes due to Qt internal memory problems perhaps.

Crash when un-doing changes

N.B. You don't need to change the tile selected, the editor will crash the next time you try to place a tile.

Support showing information for the selected Entity

When on the Entity editing mode, i can select entity on the room, the entity selector dock widget should be able to switch to the entity we selected to and show its global and local Id.

condition check error for converting layer 0 from other mapping type to type LayerTile8x8 on applying Room configuration changes

title says everything.

Add a low level save data analyzer/hex editor

We should have a dialog that allows you to see the save data:

• Should look similar to modern hex editors
• Should color code individual save chunks by type
• Which parts are considered free space should be apparent
• A percentage of the used space and fragmented space should be shown
• A bar should be shown as well which demonstrates which space is used from the start of free space to the end of the ROM
• A label should indicate that the ROM is or is not capable of being expanded to a larger size at this point
• Information about the save data chunk would be useful, such as what type of chunk this is, which level it is used in, which locations in the ROM point to it, and which other save chunks are pointed to by this chunk (for example, camera boundary table chunk)
• Identify orphaned chunks
• If we implement a defragmentation function in the future, this would be the place to put it
• Allow editing the data (and provide a warning that you may corrupt the ROM if you don't know what you are doing)

add a level exchanger so users can test different levels easily without a savefile

I feel it will be better to do this only in script.
we need to exchange the level headers, the room header table pointers and the door table pointers.
(P.S. idk if that's all the things need to do, check the code before making the new API)

Camera spinboxes fail to reset properly

This issue is intermittent and we do not know the reason why it occurs.

Door changes won't set the UnsavedChanges bool to be true

The title says it. this can only be fixed after the door undo/redo features being added.

use ctrl + left click to go to the destination Door of a Door

the title says it.

Support importing & deleting background tileset in Tileset editor

Opening the Patch Manager and re-saving will not apply changes to annotations in source files

• Open a ROM
• Open the Patch Manager
• Press the "Add" button
• Select a C patch file with annotations in it
• Press OK, then Save
• Now modify the annotations in the C file
• Open the Patch Manager
• Observe that the patch details shown in the Patch Manager do not reflect the changes to the annotations

DPI problem

Different DPI settings in different systems will cause the render of widgets in most of the windows vary, sometimes text cannot be displayed correctly due to the too big fontsize, we suggest you to set DPI to be 100% for now to use the editor.