diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contribution-quickstart-guide.md | 10 | ||||
| -rw-r--r-- | docs/project-file-structure.md | 26 | ||||
| -rw-r--r-- | docs/simulation/goods.md | 4 | ||||
| -rw-r--r-- | docs/simulation/ideologies.md | 4 | ||||
| -rw-r--r-- | docs/simulation/provinces.md | 4 | ||||
| -rw-r--r-- | docs/simulation/sim-doc-format.md | 4 | ||||
| -rw-r--r-- | docs/styleguide-cpp.md | 20 |
7 files changed, 36 insertions, 36 deletions
diff --git a/docs/contribution-quickstart-guide.md b/docs/contribution-quickstart-guide.md index 153985c..48cd11a 100644 --- a/docs/contribution-quickstart-guide.md +++ b/docs/contribution-quickstart-guide.md @@ -50,17 +50,17 @@ # Project Setup -1. [Go to the main repository](https://github.com/OpenVic2Project/OpenVic2) page on Github +1. [Go to the main repository](https://github.com/OpenVicProject/OpenVic) page on Github 2. Get the link to clone the repo  -3. Using Git, clone the repo: `git clone git@github.com:OpenVic2Project/OpenVic2.git` +3. Using Git, clone the repo: `git clone https://github.com/OpenVicProject/OpenVic`  -4. Move into the OpenVic2 directory: `cd OpenVic2` +4. Move into the OpenVic directory: `cd OpenVic` 5. Retrieve submodules: `git submodule update --init --recursive` @@ -82,7 +82,7 @@  -10. Navigate to the `OpenVic2/game/` directory and select the `project.godot` file +10. Navigate to the `OpenVic/game/` directory and select the `project.godot` file  @@ -114,4 +114,4 @@ Whenever you are ready to commit your changes follow this process: 4. Run `git push` to upload your current commits to your working branch - If you're warned that your branch has no upstream branch, run `git push --set-upstream origin my-cool-branch`, replacing "`my-cool-branch`" with whatever your branch is named in [Part 6 of Project Setup](#project-setup) -
\ No newline at end of file + 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 diff --git a/docs/simulation/goods.md b/docs/simulation/goods.md index f8204b0..7866041 100644 --- a/docs/simulation/goods.md +++ b/docs/simulation/goods.md @@ -1,8 +1,8 @@ -# OpenVic2 Goods +# OpenVic Goods ## Victoria 2 Structure -## OpenVic2 Structure +## OpenVic Structure ```mermaid classDiagram diff --git a/docs/simulation/ideologies.md b/docs/simulation/ideologies.md index 817bdb3..51e040c 100644 --- a/docs/simulation/ideologies.md +++ b/docs/simulation/ideologies.md @@ -1,8 +1,8 @@ -# OpenVic2 Ideologies +# OpenVic Ideologies ## Victoria 2 -## OpenVic2 +## OpenVic ```mermaid classDiagram diff --git a/docs/simulation/provinces.md b/docs/simulation/provinces.md index 642ff11..8ad0b25 100644 --- a/docs/simulation/provinces.md +++ b/docs/simulation/provinces.md @@ -1,6 +1,6 @@ -# OpenVic2 Provinces +# OpenVic Provinces -## OpenVic2 Structure +## OpenVic Structure ```mermaid classDiagram diff --git a/docs/simulation/sim-doc-format.md b/docs/simulation/sim-doc-format.md index 68bd905..f1d7d69 100644 --- a/docs/simulation/sim-doc-format.md +++ b/docs/simulation/sim-doc-format.md @@ -1,10 +1,10 @@ -# OpenVic2 <Document Name> +# OpenVic <Document Name> ## Victoria 2 Structure ```UML DIAGRAM``` -## OpenVic2 Structure +## OpenVic Structure ```UML DIAGRAM``` diff --git a/docs/styleguide-cpp.md b/docs/styleguide-cpp.md index 6440314..83a2647 100644 --- a/docs/styleguide-cpp.md +++ b/docs/styleguide-cpp.md @@ -1,4 +1,4 @@ -# OpenVic2 C++ Style Guidelines +# OpenVic C++ Style Guidelines ## Table of Contents 1. [Why Style?](styleguide-cpp.md#1-why-style) @@ -34,9 +34,9 @@ Source code files should adhere to the following: - Any `#include` directives should be at the top of the file - Any header files have the `.hpp` file extension - Any implementation files have the `.cpp` file extension -- Code should be within the `OpenVic2` namespace (or a nested namespace) -- Any submodules or third-party utilities should be in the `OpenVic2/extension/deps` directory -- Groups of related source files should be kept in a sub-directory of `OpenVic2/extension/src` +- Code should be within the `OpenVic` namespace (or a nested namespace) +- Any submodules or third-party utilities should be in the `OpenVic/extension/deps` directory +- Groups of related source files should be kept in a sub-directory of `OpenVic/extension/src` - Any lines that are longer than 120 characters in length should be split across multiple lines ## 2. Conventions @@ -298,22 +298,22 @@ Source code files should adhere to the following: return true; } ``` -- The include order should be: C++ standard headers, followed by Godot headers, then OpenVic2 headers +- The include order should be: C++ standard headers, followed by Godot headers, then OpenVic headers - C++ standard headers and Godot headers should be enclosed by angle brackets `<>` - - OpenVic2 headers should be enclosed by double quotes `""` + - OpenVic headers should be enclosed by double quotes `""` ```c++ //Correct #include <vector> #include <string> #include <godot_cpp/classes/object.hpp> #include <godot_cpp/core/class_db.hpp> - #include "openvic2/src/SampleHeader.hpp" - #include "openvic2/src/SampleHeader2.hpp" + #include "openvic/src/SampleHeader.hpp" + #include "openvic/src/SampleHeader2.hpp" //Incorrect - #include "openvic2/src/SampleHeader.hpp" + #include "openvic/src/SampleHeader.hpp" #include <godot_cpp/classes/object.hpp> - #include "openvic2/src/SampleHeader2.hpp" + #include "openvic/src/SampleHeader2.hpp" #include <godot_cpp/core/class_db.hpp> #include <vector> #include <string> |