diff options
Diffstat (limited to 'docs/project-file-structure.md')
| -rw-r--r-- | docs/project-file-structure.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/project-file-structure.md b/docs/project-file-structure.md index f69a372..790ca76 100644 --- a/docs/project-file-structure.md +++ b/docs/project-file-structure.md @@ -2,13 +2,13 @@ ## CPP Structure -All C++ files are in the OpenVic2/extension/ directory +All C++ files are in the OpenVic/extension/ directory Please see the [C++ Styleguide](./styleguide-cpp.md) for more details ## Godot Structure -All godot files are in the OpenVic2/game directory +All godot files are in the OpenVic/game directory ### Directories @@ -16,9 +16,9 @@ All godot files are in the OpenVic2/game directory * The root directory of the Godot Project * u/, user/, user:// * The user directory used by the project (Platform specific) - * Windows u/ - %APPDATA%/OpenVic2/ - * MacOS u/ - ~/Library/Application Support/OpenVic2/ - * Linux u/ - ~/.local/share/OpenVic2/ + * Windows u/ - %APPDATA%/OpenVic/ + * MacOS u/ - ~/Library/Application Support/OpenVic/ + * Linux u/ - ~/.local/share/OpenVic/ * d/, data/, common/ - The data directory used to store data files * can be a subdirectory of root/ - root/common/ * can be a subdirectory of user/ - user/common/ @@ -26,18 +26,18 @@ All godot files are in the OpenVic2/game directory ### Definitions -* core - OpenVic2 without modification -* mod - OpenVic2 with changes in files to modify the gameplay experience +* core - OpenVic without modification +* mod - OpenVic with changes in files to modify the gameplay experience * scene - godot engine scene object * script - godot engine gdscript object * resource - godot engine resource object * asset - static file generally used as is within the project - art, music etc. * data file - static file that holds data or information that needs to be processed to be used - economy good information, province names etc. -### OpenVic2 File Extensions +### OpenVic File Extensions -* ov2d - OpenVic2 data file -* ov2b - OpenVic2 binary file +* ovd - OpenVic data file +* ovb - OpenVic binary file ### When to use root/ @@ -180,9 +180,9 @@ root/common/technology/ root/common/pop/ ``` -Data files that are plain text should have the ov2d file extension. +Data files that are plain text should have the ovd file extension. ``` -root/common/pop/soldier.ov2d +root/common/pop/soldier.ovd ``` Data files that are complex data like a bitmap should make use of the standard file extension for that data @@ -192,7 +192,7 @@ root/common/map/provinces.bmp Data files can be further organized by subdirectory. ``` -root/common/economy/goods/Coal.ov2d +root/common/economy/goods/Coal.ovd ``` #### Naming Convention |