Skip to content

Commit

Permalink
Clarify autosaves in the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
johnnovak committed Apr 1, 2024
1 parent 2083b87 commit 943cc3b
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 22 deletions.
53 changes: 31 additions & 22 deletions sphinx-docs/source/appendixes/user-data-folder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,43 @@ User data folder
****************

The *user data folder* stores data such as your program settings, user
themes, auto saves, and the log file.
themes, autosaves, and the log file.

The location of the *user data folder* is
``C:\Users\<USERNAME>\AppData\Roaming\Gridmonger`` on Windows, and
``/Users/<USERNAME>/Library/Application Support/Gridmonger`` on macOS. For
portable installations, it is the application folder where the executable
is located.
The location of the user data folder is in a standard system location for
non-portable installations:

The user data folder contains a number of subfolders (they will be created by
the program if they don't exist):
Windows
``C:\Users\<USERNAME>\AppData\Roaming\Gridmonger``

macOS
``/Users/<USERNAME>/Library/Application Support/Gridmonger``

For portable installations, it is inside the application folder where the
Gridmonger executable resides.

The user data folder contains a number of subfolders; these are created by
the program at startup if they don't exist:

``Autosaves``
If autosaves are enabled, and the current map hasn't been saved to a file
yet, the autosave file ``Untitled.gmm`` will go into this folder. Also, in
the rare event of a program crash, unsaved maps are automatically saved
here too as ``Crash Autosave.gmm``.
If autosaves are enabled and the current map hasn't been manually saved
yet, the autosave file ``Untitled 1.gmm`` will go into this folder. If
``Untitled 1.gmm`` already exists, the name ``Untitled
2.gmm`` will be chosen, and so on. In the rare event of a program crash,
unsaved maps are automatically saved here too as ``<Map Name> Crash
Autosave.gmm``.

``Config``
The configuration file ``gridmonger.cfg`` that contains the application's
settings resides here.
Location of the ``gridmonger.cfg`` configuration file that contains the
application's settings.

``Logs``
The logs from the last run are written to the file ``gridmonger.log`` in
this folder. Log files from the last three runs can be found under the
names ``gridmonger.log.bak1``, ``gridmonger.log.bak2`` and
this folder. Log files from the last three runs are also preserved as
``gridmonger.log.bak1``, ``gridmonger.log.bak2`` and
``gridmonger.log.bak3``.

``Manual``
The included HTML user manual.
The HTML user manual you're reading now.

``User Themes``
User themes are saved into this folder. This is where you should put
Expand All @@ -49,9 +57,10 @@ the program if they don't exist):
If the application folder contains a subfolder named ``Config``, Gridmonger
will attempt to start in portable mode. Technically, you can convert a
standard installation into a portable one by moving the contents of your
user data folder into the application folder. You can also convert a
portable installation into a standard one by doing the reverse, but in
practice you're better off just using the standard installer, as that also
sets up default file associations for Gridmonger map files (``.gmm``), and
provides a standard uninstaller script.
user data folder into ``Config`` in the Gridmonger folder.

You can also do the reverse and convert a portable installation into a
standard one, but on Windows you're better off just using the standard
installer. That will also set up default file associations for Gridmonger
map files (``.gmm``) and provides a standard uninstaller script.

7 changes: 7 additions & 0 deletions sphinx-docs/source/preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ been already saved...) Also, if you're going to experiment with the editing
functions on the included example maps, it's best to either turn autosave off,
or create backup copies of the example maps first.

.. important::

If autosaves are enabled and the current map hasn't been manually saved
yet, an autosave file ``Untitled 1.gmm`` will be created in the special
``Autosave`` folder located in your :ref:`appendixes/user-data-folder:User
Data Folder`.

Below the autosave settings, you have the option to **Enable vertical sync**.
The program does its drawing just like a game engine; it's locked to your
desktop refresh rate if vertical sync is on. Disabling it may increase the
Expand Down

0 comments on commit 943cc3b

Please sign in to comment.