Skip to main content

Dreaditor

Dreaditor is a rewritten version of dread-editor. It uses PyQt instead of imgui to allow image rendering. Only works on Windows for now.

Features

  • Implement a map-viewing widget that shows an accurate minimap of the game
  • View actors on this map
  • View all actors (including sounds and lights)
  • Map uses standard zoom-and-pan controls rather than min/max X/Y coords
  • Actor data shows actordef fields as well as actor data
  • Render additional detail based on an actor's actordef
  • Render additional detail based on an actor's components
  • Render the collision cameras
  • Render details in other files such as navmesh, static geo
  • Ability to edit and save data to a "project" (a new folder which saves modified files, similar to a LayeredFS mod)

Installation

Pip:

py -m venv venv
venv\Scripts\activate
pip install dreaditor
py -m dreaditor

From source:

py -m venv venv
venv\Scripts\activate
pip install -e .
py -m dreaditor

Usage

Main Dreaditor Window

First, open File -> Select RomFS in the menu bar and select an extracted copy of your Metroid Dread RomFS. This should be a directory containing folders such as gui, packs, sounds, system and textures, as well as a config.ini file. This path will be saved in a config file and only needs to be updated if the RomFS is moved to another directory.

Next, you can select a scenario from the Select Scenario menu. For larger scenarios such as Artaria, Cataris and Dairon, this may take several seconds. It is finished when the BRFLD item on the right is checked and populated with layer data.

There are three main sections of the screen: the Actor List dock on the left, the Area Map in the middle, and the Actor Data dock on the right. These can all be used to visualize and inspect actors. Each actor can track if it is visible and if it is selected. The effects of this will be explained in the following sections as we dive into the different panels.

Actor List

The Actor List dock is a tree of all actors in the scenario. The BRFLD is the root item, and contains items for each layer - entities, sounds and lights. Each of these has a number of sublayers, each of which contains one or more actors. Adjusting the checkboxes will change the visibility of actors in the Area Map. These checkboxes are tri-state so you can easily see which layers and sublayers are hidden, fully displayed, or partially displayed.

Double-clicking on an actor will toggle its selection state, which is separate from checkboxes. Selected items are highlighted in red on the Area Map and displayed in the Actor Data dock.

Area Map

The Area Map displays a visual representation of the scenario. The gray map is generated from data stored in the game's internal minimap file (BMMAP) and shows the static collision (floors, walls, ceilings, platforms).

Each visible actor is rendered as a colored dots - green dots are entity actors, purple dots are sound actors, and yellow dots are light actors. Double-clicking on an actor will toggle its selection, highlighting it red and displaying its data in the Actor Data dock. When multiple actors are layered on one another, double-clicking will select all actors below the cursor. If you want to unselect actor(s), right click to unselect regardless of the current selection state.

Some actors have custom painters to render additional detail. For example, doors are rendered as gray rectangles, and objects with collision will render all collsion layers in red rectangles or polygons.

Actor Data

The Actor Data dock shows detailed information on actors. Each selected actor is a top-level item, and contains the level/instance data stored in the BRFLD, the actordef or BMSAD data, and collision or BMSCD data if the actor supports it.

Actors can be unselected from this pane by double-clicking on their top-level item.

Metadata

Release files for dreaditor 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dreaditor 0.1.5
File Size Uploaded Provenance Actions
dreaditor-0.1.5.tar.gz 56.1 kB Without provenance Details for dreaditor-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dreaditor 0.1.5
File Interpreter ABI Platform Actions
dreaditor-0.1.5-py3-none-any.whl Python 3 none any Details for dreaditor-0.1.5-py3-none-any.whl

Total release size: 105.0 kB

Release files / dreaditor-0.1.5.tar.gz

Download URL dreaditor-0.1.5.tar.gz
Size 56.1 kB
Tags Source
SHA-256 checksum
How to use checksums
5b5609427c1f934a53f4a03f165cb41c870c1c30f961d62c6750a2d256878ce5
BLAKE2b-256 checksum
How to use checksums
49c91cf633f37cf49bbabdac0a149e939c2b55615f0285b37ea1be5376ddd7d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / dreaditor-0.1.5-py3-none-any.whl

Download URL dreaditor-0.1.5-py3-none-any.whl
Size 48.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
56eff6997393ba2b6ce50f41bc7285bc7bbdd29d733141210aea04a964356344
BLAKE2b-256 checksum
How to use checksums
346d950e31a97d0cb23f6893812410dd8f3fa3948d793569d4d9225d4ac125a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Security for dreaditor 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page