Browse Source

Document getSaveDirectory location;

bjorn 5 years ago
parent
commit
c32867be7e
1 changed files with 10 additions and 0 deletions
  1. 10 0
      api/lovr/filesystem/getSaveDirectory.lua

+ 10 - 0
api/lovr/filesystem/getSaveDirectory.lua

@@ -9,6 +9,16 @@ return {
       description = 'The absolute path to the save directory.'
       description = 'The absolute path to the save directory.'
     }
     }
   },
   },
+  notes = [[
+    The save directory takes the following form:
+
+    ```
+    <appdata>/LOVR/<identity>
+    ```
+
+    Where `<appdata>` is `lovr.filesystem.getAppdataDirectory` and `<identity>` is
+    `lovr.filesystem.getIdentity` and can be customized using `lovr.conf`.
+  ]],
   related = {
   related = {
     'lovr.filesystem.getIdentity',
     'lovr.filesystem.getIdentity',
     'lovr.filesystem.getAppdataDirectory'
     'lovr.filesystem.getAppdataDirectory'