Created Useful Modding Tools (markdown)

Hiram Anderson 2021-02-18 23:48:12 -06:00
parent f3b33df2c0
commit 5c670492c9
1 changed files with 36 additions and 0 deletions

36
Useful-Modding-Tools.md Normal file

@ -0,0 +1,36 @@
The vast majority of edits to pokeemerald are done either by modifying the code files in a text editor, or editing resource files with general-use programs such as image or sound editors. However, some parts of the repository either require special tools to properly edit them, or editing them becomes significantly easier with the use of said tools.
This page lists some helpful tools for creating custom games in pokeemerald, as well as a short summary and a link to its page. If you require assistance in using any of these tools, help can always be found on the pret discord.
# Porymap
**Type:** Map Editor
**Usefulness:** Essentially required
**Maintainer:** huderlem
**Download:** [Github Repository](https://github.com/huderlem/porymap)
![Porymap](https://github.com/huderlem/porymap/blob/master/docsrc/manual/images/introduction/porymap-loaded-project.png)
Porymap is a nearly universally-used editor for creating maps in Generation 3 decompilation projects. Not only does it handle the nitty-gritty of creating the map json files used by pokeemerald, but allows you to add and edit events, warps, connections, and much more with ease. There are also some miscellaneous features to help with mapping.
# Poryscript
**Type:** Script Compiler
**Usefulness:** Makes scripting easier
**Maintainer:** huderlem
**Download:** [Github Repository](https://github.com/huderlem/poryscript)
Poryscript is a new scripting language that can be added to your Makefile to automatically compile into normal scripts when building your ROM. Much of its syntax is the same as normal scripts, but it adds some basic features to make scripting easier, such as high-level control logic (proper if/then statements), an auto-formatter for message boxes, and improved map script organization. Those wishing to make complicated scripts in their hack should consider including this in their project.
[You can test it online here.](http://www.huderlem.com/poryscript-playground/)
# Tilemap Studio
**Type:** Tilemap/Tileset Editor
**Usefulness:** For creating backgrounds
**Maintainer:** Rangi42
**Download:** [Github Repository](https://github.com/Rangi42/tilemap-studio)
![Tilemap Studio](https://github.com/Rangi42/tilemap-studio/blob/master/screenshot.png)
The vast majority of background images in pokeemerald use a graphical data file called a **tilemap**, which splits the background images into 8x8 pixel chunks to save space in memory. If you wish to edit these backgrounds, this tool will do the splitting for you and allow you to create the tilemaps to use in your project.