Leahnaya/porymap
1
0
Fork 0
mirror of https://github.com/huderlem/porymap.git synced 2026-08-17 22:28:35 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

add list of files porymap edits to docs

Browse Source
This commit is contained in:
garak
2019-10-01 00:07:49 -04:00
committed by huderlem
parent 5409855efd
commit da59c82b7d
21 changed files with 598 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docsrc/index.rst
View File

@@ -17,6 +17,7 @@ Porymap Documentation
manual/editing-map-connections
manual/editing-wild-encounters
manual/region-map-editor
manual/project-files
.. toctree::
:maxdepth: 2

46
docsrc/manual/project-files.rst Normal file
View File

@@ -0,0 +1,46 @@
*************
Project Files
*************
Porymap relies on the user maintaining a certain level of integrity with their project files.
This is a list of files that porymap reads from and writes to. Generally, if porymap writes
to a file, it probably is not a good idea to edit yourself unless otherwise noted.
.. csv-table::
:header: File Name,Read,Write,Notes
:widths: 20, 5, 5, 30
data/maps/\*/map.json, yes, yes,
data/event_scripts.s, no, yes, only appends new script files to end of file
data/maps/map_groups.json, yes, yes,
data/layouts/layouts.json, yes, yes, also reads border and blockdata files listed in this file
data/tilesets/headers.inc, yes, yes,
data/tilesets/graphics.inc, yes, yes, also edits palette and tile image files listed in this file
data/tilesets/metatiles.inc, yes, yes, also edits metatile files listed in this file
src/data/wild_encounters.json, yes, yes,
src/data/field_event_obj/event_object_graphics_info_pointers.h, yes, no,
src/data/field_event_obj/event_object_graphics_info.h, yes, no,
src/data/field_event_obj/event_object_pic_tables.h, yes, no,
src/data/field_event_obj/event_object_graphics.h, yes, no,
src/data/graphics/pokemon.h, yes, no, for pokemon sprite icons
src/data/heal_locations.h, yes, yes,
src/data/region_map/region_map_entries.h, yes, yes,
include/constants/map_groups.h, no, yes,
include/constants/items.h, yes, no,
include/constants/flags.h, yes, no,
include/constants/vars.h, yes, no,
include/constants/weather.h, yes, no,
include/constants/heal_locations.h, no, yes,
include/constants/pokemon.h, yes, no, reads min and max level constants
include/constants/map_types.h, yes, no,
include/constants/secret_bases.h, yes, no,
include/constants/event_object_movement_constants.h, yes, no,
include/constants/bg_event_constants.h, yes, no,
include/constants/region_map_sections.h, yes, no,
include/constants/metatile_labels.h, yes, yes,
include/constants/metatile_behaviors.h, yes, no,
include/constants/bg_event_constants.h, yes, no,
include/fieldmap.h, yes, no, reads tileset related constants