add list of files porymap edits to docs

docs/_sources/index.rst.txt

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

docs/_sources/manual/project-files.rst.txt

@@ -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
+
+

docs/genindex.html

@@ -145,6 +145,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/index.html

@@ -145,6 +145,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -323,6 +324,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
 </ul>
 </div>
 <div class="toctree-wrapper compound">

docs/manual/editing-map-collisions.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-connections.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-events.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-header.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-tiles.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-wild-encounters.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/introduction.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/navigation.html

@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/project-files.html

@@ -0,0 +1,484 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>Project Files &mdash; porymap  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+  
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
+    
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+    
+
+  
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="Changelog" href="../reference/changelog.html" />
+    <link rel="prev" title="The Region Map Editor" href="region-map-editor.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search"  style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
+          
+
+          
+            <a href="../index.html" class="icon icon-home"> porymap
+          
+
+          
+          </a>
+
+          
+            
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">User Manual</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#tileset-editor">Tileset Editor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#region-map-editor">Region Map Editor</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-wild-encounters.html">Editing Wild Encounters</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Project Files</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">porymap</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+        
+      <li>Project Files</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            
+              <a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/project-files.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="project-files">
+<h1>Project Files<a class="headerlink" href="#project-files" title="Permalink to this headline">¶</a></h1>
+<p>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.</p>
+<table border="1" class="colwidths-given docutils">
+<colgroup>
+<col width="33%" />
+<col width="8%" />
+<col width="8%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">File Name</th>
+<th class="head">Read</th>
+<th class="head">Write</th>
+<th class="head">Notes</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>data/maps/*/map.json</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>data/event_scripts.s</td>
+<td>no</td>
+<td>yes</td>
+<td>only appends new script files to end of file</td>
+</tr>
+<tr class="row-even"><td>data/maps/map_groups.json</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>data/layouts/layouts.json</td>
+<td>yes</td>
+<td>yes</td>
+<td>also reads border and blockdata files listed in this file</td>
+</tr>
+<tr class="row-even"><td>data/tilesets/headers.inc</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>data/tilesets/graphics.inc</td>
+<td>yes</td>
+<td>yes</td>
+<td>also edits palette and tile image files listed in this file</td>
+</tr>
+<tr class="row-even"><td>data/tilesets/metatiles.inc</td>
+<td>yes</td>
+<td>yes</td>
+<td>also edits metatile files listed in this file</td>
+</tr>
+<tr class="row-odd"><td>src/data/wild_encounters.json</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>src/data/field_event_obj/event_object_graphics_info_pointers.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>src/data/field_event_obj/event_object_graphics_info.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>src/data/field_event_obj/event_object_pic_tables.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>src/data/field_event_obj/event_object_graphics.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>src/data/graphics/pokemon.h</td>
+<td>yes</td>
+<td>no</td>
+<td>for pokemon sprite icons</td>
+</tr>
+<tr class="row-odd"><td>src/data/heal_locations.h</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>src/data/region_map/region_map_entries.h</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/map_groups.h</td>
+<td>no</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/constants/items.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/flags.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/constants/vars.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/weather.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/constants/heal_locations.h</td>
+<td>no</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/pokemon.h</td>
+<td>yes</td>
+<td>no</td>
+<td>reads min and max level constants</td>
+</tr>
+<tr class="row-even"><td>include/constants/map_types.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/secret_bases.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/constants/event_object_movement_constants.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/bg_event_constants.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/constants/region_map_sections.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/metatile_labels.h</td>
+<td>yes</td>
+<td>yes</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/constants/metatile_behaviors.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>include/constants/bg_event_constants.h</td>
+<td>yes</td>
+<td>no</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>include/fieldmap.h</td>
+<td>yes</td>
+<td>no</td>
+<td>reads tileset related constants</td>
+</tr>
+</tbody>
+</table>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="region-map-editor.html" class="btn btn-neutral float-left" title="The Region Map Editor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2019, huderlem
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+  
+  
+    
+   
+
+</body>
+</html>

docs/manual/region-map-editor.html

@@ -36,7 +36,7 @@
   <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Changelog" href="../reference/changelog.html" />
+    <link rel="next" title="Project Files" href="project-files.html" />
     <link rel="prev" title="Editing Wild Encounters" href="editing-wild-encounters.html" /> 
 </head>
 
@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -363,7 +364,7 @@ but that functionality will be added in a future update.</p>
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="project-files.html" class="btn btn-neutral float-right" title="Project Files" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="editing-wild-encounters.html" class="btn btn-neutral float-left" title="Editing Wild Encounters" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

docs/reference/changelog.html

@@ -37,7 +37,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Related Projects" href="related-projects.html" />
-    <link rel="prev" title="The Region Map Editor" href="../manual/region-map-editor.html" /> 
+    <link rel="prev" title="Project Files" href="../manual/project-files.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -146,6 +146,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul class="current">
@@ -443,7 +444,7 @@ and this project somewhat adheres to <a class="reference external" href="https:/
         <a href="related-projects.html" class="btn btn-neutral float-right" title="Related Projects" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="../manual/region-map-editor.html" class="btn btn-neutral float-left" title="The Region Map Editor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="../manual/project-files.html" class="btn btn-neutral float-left" title="Project Files" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

docs/reference/related-projects.html

@@ -145,6 +145,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul class="current">

docs/search.html

@@ -145,6 +145,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docsrc/index.rst

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

docsrc/manual/project-files.rst

@@ -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
+
+