Skip to content

Latest commit

 

History

History
60 lines (32 loc) · 2.53 KB

README.md

File metadata and controls

60 lines (32 loc) · 2.53 KB

dungeon-mystery

npm

dungeon-mystery512x487

Logo by @sgtmug

dungeon-mystery is a Typescript implementation of Pokémon Mystery Dungeon: Explorers of Sky's dungeon algorithm.

This package is the main code behind Pokémon Dungeoneer, a web tool for generating and visualizing PMD layouts.

It's built to replicate the original algorithm as closely as possible, while also being much more readable and useful as a reference.

This package features:

  • Fully commented functions with address references for the NA version of Explorers of Sky
  • Complete map generation, returning all relevant data associated with the map as used in the game.

Installation

npm install dungeon-mystery

Documentation

Documentation is available here!

License

GNU GPL v3

Sources

This project could not exist without the amazing work by members of the community who have researched and documented the map generation process extensively.

pmdsky-debug - Central resource for debugging information to reverse engineer Explorers of Sky

dungeon-eos - Python implementation of the dungeon algorithm used as part of SkyTemple

Map generation - Document by End45 detailing the map generation process

Dungeon data - Document by End45 detailing how dungeon-related data is organized and structured

Images

These images use the built-in CreateMapString function which builds a representation of the map into a simplified subset of characters.

dungeon-mystery Beetle Layout Example

An example layout using FloorLayout.LAYOUT_BEETLE.

dungeon-mystery Large Layout with Water Example

An example layout using FloorLayout.LAYOUT_LARGE with secondary terrain and structures enabled.

Support

If you like the things I make, consider supporting me on my ko-fi page: https://ko-fi.com/epicyoshimaster!