Leahnaya/porymap
1
0
Fork 0
mirror of https://github.com/huderlem/porymap.git synced 2026-10-01 12:26:37 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Split project config

Browse Source 
- Project config is now split into project and user config.
- Backwards compatibility with the old project config included, porting old project items over to the new user config.
This commit is contained in:
tustin2121
2022-09-01 00:57:31 -04:00
parent 0fa71dc4c8
commit 8e83daac84
7 changed files with 147 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docsrc/manual/settings-and-options.rst
View File

@@ -10,7 +10,11 @@ A global settings file is stored in a platform-dependent location for app config
A config file is also created when opening a project in porymap for the first time. It is stored in
your project root as ``porymap.project.cfg``. There are several project-specific settings that are
determined by this file.
determined by this file. You may want to check in this file so that other users will have your
porject settings.
A second config file is created for user-specific settings. It is stored in
your project root as ``porymap.user.cfg``. You should add this file to your gitignore.
.. csv-table::
:header: Setting,Default,Location,Can Edit?,Description
@@ -18,7 +22,7 @@ determined by this file.
``recent_project``, , global, yes, The project that will be opened on launch
``reopen_on_launch``, 1, global, yes, Whether the most recent project should be opened on launch
``recent_map``, , global, yes, The map that will be opened on launch
``recent_map``, , user, yes, The map that will be opened on launch
``pretty_cursors``, 1, global, yes, Whether to use custom crosshair cursors
``map_sort_order``, group, global, yes, The order map list is sorted in
``window_geometry``, , global, no, For restoring window sizes
@@ -35,7 +39,7 @@ determined by this file.
``text_editor_goto_line``, , global, yes, The command that will be executed when clicking the button next the ``Script`` combo-box.
``text_editor_open_directory``, , global, yes, The command that will be executed when clicking ``Open Project in Text Editor``.
``base_game_version``, , project, no, The base pret repo for this project
``use_encounter_json``, 1, project, yes, Enables wild encounter table editing
``use_encounter_json``, 1, user, yes, Enables wild encounter table editing
``use_poryscript``, 0, project, yes, Whether to open .pory files for scripts
``use_custom_border_size``, 0, project, yes, Whether to allow variable border sizes
``enable_event_weather_trigger``, 1 if not ``pokefirered``, project, yes, Allows adding Weather Trigger events
@@ -47,6 +51,6 @@ determined by this file.
``enable_floor_number``, 1 if ``pokefirered``, project, yes, Adds ``Floor Number`` to map headers
``create_map_text_file``, 1 if not ``pokeemerald``, project, yes, A ``text.inc`` or ``text.pory`` file will be created for any new map
``enable_triple_layer_metatiles``, 0, project, yes, Enables triple-layer metatiles (See https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles)
``custom_scripts``, , project, yes, A list of script files to load into the scripting engine
``custom_scripts``, , user, yes, A list of script files to load into the scripting engine
Some of these settings can be toggled manually in porymap via the *Options* menu.