Skip to content

Commit

Permalink
Add images to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
EpicYoshiMaster committed Dec 4, 2024
1 parent 21ebc4b commit a23726d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

![dungeon-mystery512x487](https://github.com/EpicYoshiMaster/dungeon-mystery/assets/32598419/8aeb7f74-c97d-473b-943a-115f4c83e015)

Logo by [@sgtmug](https://twitter.com/sergeantmug)
Logo by [@sgtmug](https://sgtmug.carrd.co/)

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](https://github.com/EpicYoshiMaster/pokemon-dungeoneer), a web tool for generating and visualizing PMD layouts.
Expand Down Expand Up @@ -43,6 +43,18 @@ This project could not exist without the amazing work by members of the communit

[Dungeon data](https://docs.google.com/document/d/1UfiFz4xAPtGd-1X2JNE0Jy2z-BLkze1PE4Fo9u-QeYo/edit) - 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](./screenshots/dungeonmysterybeetle.png)

An example layout using `FloorLayout.LAYOUT_BEETLE`.

![dungeon-mystery Large Layout with Water Example](./screenshots/dungeonmysterylargewater.png)

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](https://ko-fi.com/epicyoshimaster)!
Binary file added screenshots/dungeonmysterybeetle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/dungeonmysterylargewater.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a23726d

Please sign in to comment.