|
6 | 6 | namespace geode::dirs { |
7 | 7 | /** |
8 | 8 | * Directory where Geometry Dash is |
| 9 | + * |
| 10 | + * Windows: {GD installation folder}/ (traditionally Geometry Dash) |
| 11 | + * macOS: {GD installation folder}/ (traditionally GeometryDash.app) |
| 12 | + * Android: {Android Launcher's media directory}/game |
| 13 | + * iOS: Documents/game (within the launcher's sandbox) |
9 | 14 | */ |
10 | 15 | GEODE_DLL std::filesystem::path getGameDir(); |
11 | 16 | /** |
12 | 17 | * Directory where GD saves its files |
| 18 | + * |
| 19 | + * Windows: %LOCALAPPDATA%/{executable name} |
| 20 | + * macOS: ~/Library/Application Support/GeometryDash |
| 21 | + * Android: {Android Launcher's media directory}/save |
| 22 | + * iOS: Documents/save (within the launcher's sandbox) |
13 | 23 | */ |
14 | 24 | GEODE_DLL std::filesystem::path getSaveDir(); |
15 | 25 | /** |
16 | 26 | * Directory where Geode is |
| 27 | + * `getGameDir()`/geode |
17 | 28 | */ |
18 | 29 | GEODE_DLL std::filesystem::path getGeodeDir(); |
19 | 30 | /** |
20 | 31 | * Directory where Geode saves its files |
| 32 | + * `getSaveDir()`/geode |
21 | 33 | */ |
22 | 34 | GEODE_DLL std::filesystem::path getGeodeSaveDir(); |
23 | 35 | /** |
24 | 36 | * Directory where Geode's resources are stored |
| 37 | + * `getGeodeDir()`/resources |
25 | 38 | */ |
26 | 39 | GEODE_DLL std::filesystem::path getGeodeResourcesDir(); |
27 | 40 | /** |
28 | | - * Directory where Geode's resources are stored |
| 41 | + * Directory where Geode's logs are stored |
| 42 | + * `getGeodeDir()`/logs |
29 | 43 | */ |
30 | 44 | GEODE_DLL std::filesystem::path getGeodeLogDir(); |
31 | 45 | /** |
32 | 46 | * Directory to store temporary files |
| 47 | + * `getGeodeDir()`/temp |
33 | 48 | */ |
34 | 49 | GEODE_DLL std::filesystem::path getTempDir(); |
35 | 50 | /** |
36 | 51 | * Directory where mods are stored by default |
| 52 | + * `getGeodeDir()`/mods |
37 | 53 | */ |
38 | 54 | GEODE_DLL std::filesystem::path getModsDir(); |
39 | 55 | /** |
40 | 56 | * Directory where mods' save data is stored |
| 57 | + * `getGeodeSaveDir()`/mods |
41 | 58 | */ |
42 | 59 | GEODE_DLL std::filesystem::path getModsSaveDir(); |
43 | 60 | /** |
44 | 61 | * Directory where mods' unzipped packages are stored at runtime |
| 62 | + * |
| 63 | + * Windows/macOS/iOS: `getGeodeDir()`/unzipped |
| 64 | + * Android: {Android Launcher's internal files directory}/geode/unzipped |
45 | 65 | */ |
46 | 66 | GEODE_DLL std::filesystem::path getModRuntimeDir(); |
47 | 67 | /** |
48 | 68 | * Directory where mods' unzipped binary files are stored |
49 | 69 | * This is used in order to override existing unzip binaries, |
50 | 70 | * such as on iOS where signing the binary is required |
51 | 71 | * |
52 | | - * TODO: enable on 4.7.0 |
| 72 | + * TODO: enable on ~~4.7.0~~ nice job |
53 | 73 | */ |
54 | 74 | // GEODE_DLL std::filesystem::path getModBinariesDir(); |
55 | 75 | /** |
56 | 76 | * Directory where mods' config files lie |
| 77 | + * `getGeodeDir()`/config |
57 | 78 | */ |
58 | 79 | GEODE_DLL std::filesystem::path getModConfigDir(); |
59 | 80 | /** |
60 | 81 | * Directory where Geode stores the cached index |
| 82 | + * `getGeodeDir()`/index |
61 | 83 | */ |
62 | 84 | GEODE_DLL std::filesystem::path getIndexDir(); |
63 | 85 | /** |
64 | 86 | * Directory where crashlogs are stored |
| 87 | + * `getGeodeDir()`/crashlogs |
65 | 88 | */ |
66 | 89 | GEODE_DLL std::filesystem::path getCrashlogsDir(); |
67 | 90 | /** |
68 | 91 | * Directory where mods' persistent files lie |
69 | 92 | * This directory is not deleted even when Geode is uninstalled |
| 93 | + * `getSaveDir()`/geode-persistent |
70 | 94 | */ |
71 | 95 | GEODE_DLL std::filesystem::path getModPersistentDir(); |
72 | 96 | /** |
73 | 97 | * Directory where Geometry Dash's resources are stored |
74 | | - * On Android, the resources are stored in the APK, so this just returns "assets" |
| 98 | + * |
| 99 | + * Windows/macOS: `getGameDir()`/Resources |
| 100 | + * Android: assets |
| 101 | + * iOS: {GD bundle path}/Resources |
75 | 102 | */ |
76 | 103 | GEODE_DLL std::filesystem::path getResourcesDir(); |
77 | 104 | } |
0 commit comments