Skip to content

Submitting Room Jam Rooms

Ellendar edited this page Dec 4, 2023 · 2 revisions

Submitting a room

  1. Create your room using Z2Edit (Download Here). You can make a new room or overwrite any room you feel like.
    1. Set the exits you want to be valid to go somewhere. It doesn't matter what room they are set to, as long as valid exits go somewhere, and invalid exits go outside.
    2. Make sure to add some enemies that make sense for that room. Think about what they could be if enemy shuffle is on.
  2. Export your rom using File/Export ROM (as)
  3. Run DumpRooms.exe on your updated ROM. This will be in your Z2Randomizer folder.
    1. In windows, you can do this by dragging the rom onto the DumpRooms.exe
    2. From the command line, just run DumpRooms.exe path_to_your_rom
  4. Open the Rooms.dump file in your choice of text editor
  5. Find your room in the file. It will have the map equal to the map number you can see in the upper left of the Sideview Editor in Z2Edit (note this is the first number, so "33: Palace2 12" is Map 33, not 12. If your room is in palace 1, 2, or 5, find the room with PalaceGroup: 1. For 3, 4, or 6, PalaceGroup: 2. For GP, PalaceGroup 3.
  6. Update the name. This can be a descriptive name or something fun.
  7. Update the author to your name!
  8. Copy your room from the rooms dump into the #roomJam channel on discord. Include the whole room including the {} characters at the start/end. And example is below. Include a screenshot from Z2Edit so people can view it and give feedback.

Example:

{
    "author": "ExampleRoom",
    "bitmask": "0F",
    "connections": "0F000214",
    "elevatorScreen": 2,
    "enabled": true,
    "enemies": "050F0B00CB",
    "group": "v4_4",
    "hasBoss": false,
    "hasDrop": false,
    "hasItem": false,
    "isBossRoom": false,
    "isDropZone": false,
    "IsEntrance": false,
    "isEntrance": false,
    "IsThunderBirdRoom": false,
    "isThunderBirdRoom": false,
    "isUpDownReversed": false,
    "linkedRoomName": null,
    "LinkedRoomName": null,
    "map": 4,
    "memoryAddress": 67387,
    "name": "ExampleRoom",
    "palaceGroup": 1,
    "palaceNumber": null,
    "requirements":
        [
        ],
    "sideviewData": "3A600E08D208420022C8420022C8420022C8420022C8420022C8420022C84200D40E07F1F050B071D708420022C8420022C8420022C84200D20E"
}

Do's and Don'ts

Do:

  1. Make all kinds of rooms. Normal rooms, item rooms, drops, boss rooms, entrances! I've made a bunch of changes so we can support lots of room types we couldn't customize before.
  2. Make rooms with interesting requirement combinations. The logic is a lot better now about supporting all kinds of requirements.
  3. Use 4.3.0 to generate your rooms. If you generate the room on an older version, the format will not work correctly.

Don't:

  1. Don't include an item statue or key door on the same screen as an item. Each room is 4 screens wide. You can see this in z2edit by changing the screen selector in the top left. If you have ether of these on the same screen as an item (for an item room) it will cause the despawning item bug.
  2. Don't use the elevator enemy. There is an elevator enemy (#13) that does not work properly and causes issues. If you want to place an elevator, use command 15, object 50 in the map commands tab.
  3. Don't make rooms where someone can get stuck. If there is a place someone can possibly get trapped in, but some lava or enemies in there so they can at least take a death. This isn't a hard rule, but please don't.
  4. Don't include invisible walls unless your room is a variation on a vanilla room with invisible walls. If you have a really good idea for this I'll consider it, but your room should be beatable by someone who has never seen it before.

Clone this wiki locally