Skip to content

PlatinumLucario/AwesomeMapEditor

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Awesome Map Editor

Awesome Map Editor (AME) is a map editor for 3rd generation Pokémon games: Ruby, Sapphire, FireRed, LeafGreen, and Emerald.

Please note that AME currently cannot write to ROMs, which means the save function is unusable, as this functionality has not been implemented yet.

Dependencies

QBoy
yaml-cpp

Getting Started

First, you will need to install Qt Creator, you can download it at https://www.qt.io/download-open-source

  1. Create a folder named AME (or whatever you'd like to call it), this will be the folder used for the AME root directory.

  2. Ensure that Cmake is installed during the installation of Qt. It's required in order to open the CMakeLists.txt file and build yaml-cpp.

Building (GNU/Linux)

Setting up the directories

  1. Place the dependencies in the same directory as the AME root and rename them as the following: QBoy-master > QBoy and yaml-cpp-master > yaml-cpp.

  2. Create a folder named "bin" in both ../[AMEroot]/QBoy and ../[AMEroot]/yaml-cpp directories (must be at the root of those directories).

  3. Create two folders in ../[AMEroot]/QBoy/bin and name them "debug" and "release".

So the directories you made should look somewhat like this:

[AME Root directory]
├── AwesomeMapEditor
├── QBoy
│    └── bin
│         ├── debug
│         └── release
└── yaml-cpp
     └── bin

Building AME

  1. Open all the projects in Qt and set QBoy build directories to ../[AMEroot]/QBoy/bin/debug and
    ../[AMEroot]/QBoy/bin/release respectively and set yaml-cpp build directory to ../[AMEroot]/yaml-cpp/bin. For yaml-cpp, open the CMakeLists.txt file and ensure BUILD_SHARED_LIBS is enabled in its project settings.

  2. Build them all, working forwards from yaml-cpp to QBoy to AME itself.

  3. Copy the ../[AMEroot]/AwesomeMapEditor/resources/config folder into the AME executable directory (usually named build-AwesomeMapEditor-Desktop_Qt_[version-number]_[kit-used]_64bit-[debug-or-release]).

Building (Windows)

Setting up the directories

  1. Place the dependencies in the same directory as the AME root and rename them as the following: QBoy-master > QBoy and yaml-cpp-master > yaml-cpp.

  2. Create a folder named "bin" in both ../[AMEroot]/QBoy and ../[AMEroot]/yaml-cpp directories (must be at the root of those directories).

  3. Create two folders in ../[AMEroot]/QBoy/bin and name them "debug" and "release".

So the directories you made should look somewhat like this:

[AME Root directory]
├── AwesomeMapEditor
├── QBoy
│    └── bin
│         ├── debug
│         └── release
└── yaml-cpp
     └── bin

Building AME

  1. Open all the projects in Qt and set QBoy build directories to ../[AMEroot]/QBoy/bin/debug and
    ../[AMEroot]/QBoy/bin/release respectively and set yaml-cpp build directory to ../[AMEroot]/yaml-cpp/bin. For yaml-cpp, open the CMakeLists.txt file and ensure BUILD_SHARED_LIBS is enabled in its project settings. YAML_CPP_BUILD_TESTS must also be disabled in the its project settings, otherwise GTest (Google Test Framework) build errors will prevent it from being built, as it doesn't work with MinGW for some reason.

  2. Build them all, working forwards from yaml-cpp to QBoy to AME itself.

  3. Copy the ../[AMEroot]/AwesomeMapEditor/resources/config folder into the AME executable directory (usually named build-AwesomeMapEditor-Desktop_Qt_[version-number]_[kit-used]_64bit-[debug-or-release]).

Now you can help us develop the future of Pokémon ROM hacking!

Credits

Diegoisawesome - Developer

Pokedude - Developer

About

A tool to edit maps and more in 3rd generation Pokémon ROMs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 98.6%
  • Other 1.4%