no points for guessing what it does

Author: qimiko

loader/include/Geode/loader/Dirs.hpp

@@ -6,72 +6,99 @@
 namespace geode::dirs {
     /**
      * Directory where Geometry Dash is
+     *
+     * Windows: {GD installation folder}/ (traditionally Geometry Dash)
+     * macOS: {GD installation folder}/ (traditionally GeometryDash.app)
+     * Android: {Android Launcher's media directory}/game
+     * iOS: Documents/game (within the launcher's sandbox)
      */
     GEODE_DLL std::filesystem::path getGameDir();
     /**
      * Directory where GD saves its files
+     *
+     * Windows: %LOCALAPPDATA%/{executable name}
+     * macOS: ~/Library/Application Support/GeometryDash
+     * Android: {Android Launcher's media directory}/save
+     * iOS: Documents/save (within the launcher's sandbox)
      */
     GEODE_DLL std::filesystem::path getSaveDir();
     /**
      * Directory where Geode is
+     * `getGameDir()`/geode
      */
     GEODE_DLL std::filesystem::path getGeodeDir();
     /**
      * Directory where Geode saves its files
+     * `getSaveDir()`/geode
      */
     GEODE_DLL std::filesystem::path getGeodeSaveDir();
     /**
      * Directory where Geode's resources are stored
+     * `getGeodeDir()`/resources
      */
     GEODE_DLL std::filesystem::path getGeodeResourcesDir();
     /**
-     * Directory where Geode's resources are stored
+     * Directory where Geode's logs are stored
+     * `getGeodeDir()`/logs
      */
     GEODE_DLL std::filesystem::path getGeodeLogDir();
     /**
      * Directory to store temporary files
+     * `getGeodeDir()`/temp
      */
     GEODE_DLL std::filesystem::path getTempDir();
     /**
      * Directory where mods are stored by default
+     * `getGeodeDir()`/mods
      */
     GEODE_DLL std::filesystem::path getModsDir();
     /**
      * Directory where mods' save data is stored
+     * `getGeodeSaveDir()`/mods
      */
     GEODE_DLL std::filesystem::path getModsSaveDir();
     /**
      * Directory where mods' unzipped packages are stored at runtime
+     *
+     * Windows/macOS/iOS: `getGeodeDir()`/unzipped
+     * Android: {Android Launcher's internal files directory}/geode/unzipped
      */
     GEODE_DLL std::filesystem::path getModRuntimeDir();
     /**
      * Directory where mods' unzipped binary files are stored
      * This is used in order to override existing unzip binaries,
      * such as on iOS where signing the binary is required
      *
-     * TODO: enable on 4.7.0
+     * TODO: enable on ~~4.7.0~~ nice job
      */
     // GEODE_DLL std::filesystem::path getModBinariesDir();
     /**
      * Directory where mods' config files lie
+     * `getGeodeDir()`/config
      */
     GEODE_DLL std::filesystem::path getModConfigDir();
     /**
      * Directory where Geode stores the cached index
+     * `getGeodeDir()`/index
      */
     GEODE_DLL std::filesystem::path getIndexDir();
     /**
      * Directory where crashlogs are stored
+     * `getGeodeDir()`/crashlogs
      */
     GEODE_DLL std::filesystem::path getCrashlogsDir();
     /**
      * Directory where mods' persistent files lie
      * This directory is not deleted even when Geode is uninstalled
+     * `getSaveDir()`/geode-persistent
      */
     GEODE_DLL std::filesystem::path getModPersistentDir();
     /**
      * Directory where Geometry Dash's resources are stored
-     * On Android, the resources are stored in the APK, so this just returns "assets"
+     *
+     * Windows/macOS: `getGameDir()`/Resources
+     * Android: assets
+     * iOS: {GD bundle path}/Resources
      */
     GEODE_DLL std::filesystem::path getResourcesDir();
 }

loader/include/Geode/loader/Mod.hpp

@@ -150,15 +150,18 @@ namespace geode {
 
         /**
          * Get the mod's save directory path
+         * `geode::dirs::getModsSaveDir()`/{mod_id}/
          */
         std::filesystem::path getSaveDir() const;
         /**
          * Get the mod's config directory path
+         * `geode::dirs::getModConfigDir()`/{mod_id}/
          */
         std::filesystem::path getConfigDir(bool create = true) const;
         /**
          * Get the mod's persistent directory path
          * This directory is not deleted even when Geode/mod is uninstalled
+         * `geode::dirs::getModPersistentDir()`/{mod_id}/
          */
         std::filesystem::path getPersistentDir(bool create = true) const;