porymap/README.md

22 lines
1 KiB
Markdown
Raw Normal View History

2021-01-20 19:21:51 +00:00
# Porymap
2018-01-30 02:45:13 +00:00
2020-12-11 23:50:54 +00:00
[![Actions Status](https://github.com/huderlem/porymap/workflows/Build%20Porymap/badge.svg)](https://github.com/huderlem/porymap/actions)
2021-01-20 19:21:51 +00:00
A map editor for the Pokémon generation 3 decompilation projects ([pokeruby][pokeruby], [pokeemerald][pokeemerald], and [pokefirered][pokefirered]).
2018-09-13 03:10:28 +01:00
2021-01-20 19:21:51 +00:00
To get started, view the full online guide here: https://huderlem.github.io/porymap/
2019-05-27 19:31:23 +01:00
2018-12-27 14:41:35 +00:00
View the [Changelog][changelog] to see what's new, and download the latest version from the [Releases][releases].
2018-01-30 02:45:13 +00:00
2021-01-20 19:21:51 +00:00
![Porymap Preview](docsrc/manual/images/introduction/porymap-loaded-project.png)
## Local Development
Read [INSTALL.md](INSTALL.md) for instructions on how to compile Porymap from source. If you simply want to use Porymap, download the latest version from the [Releases][releases].
2018-01-30 02:45:13 +00:00
[pokeruby]: https://github.com/pret/pokeruby
2018-09-13 03:10:28 +01:00
[pokeemerald]: https://github.com/pret/pokeemerald
2020-04-20 19:26:16 +01:00
[pokefirered]: https://github.com/pret/pokefirered
2018-12-27 14:41:35 +00:00
[changelog]: https://github.com/huderlem/porymap/blob/master/CHANGELOG.md
[releases]: https://github.com/huderlem/porymap/releases