aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
author Hop311 <hop3114@gmail.com>2023-05-16 23:49:52 +0200
committer Hop311 <hop3114@gmail.com>2023-05-17 13:47:02 +0200
commit578eb8c332810656842f72e0bb94bb0d4dcb9f5e (patch)
tree64dd37032c36da8e48d5d519ac840e11cc64dc58 /docs
parentaf6a96ed26bca3eaa28c6dca635918061fab7c80 (diff)
Changed from OpenVic2 to OpenVic
Diffstat (limited to 'docs')
-rw-r--r--docs/contribution-quickstart-guide.md8
-rw-r--r--docs/project-file-structure.md12
-rw-r--r--docs/simulation/goods.md4
-rw-r--r--docs/simulation/ideologies.md4
-rw-r--r--docs/simulation/provinces.md4
-rw-r--r--docs/simulation/sim-doc-format.md4
-rw-r--r--docs/styleguide-cpp.md14
7 files changed, 25 insertions, 25 deletions
diff --git a/docs/contribution-quickstart-guide.md b/docs/contribution-quickstart-guide.md
index ba4c947..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/OpenVic) 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
![](images/proj-setup/01-git-clone-link.png)
-3. Using Git, clone the repo: `git clone https://github.com/OpenVicProject/OpenVic.git`
+3. Using Git, clone the repo: `git clone https://github.com/OpenVicProject/OpenVic`
![](images/proj-setup/02-git-clone.png)
-4. Move into the OpenVic2 directory: `cd OpenVic`
+4. Move into the OpenVic directory: `cd OpenVic`
5. Retrieve submodules: `git submodule update --init --recursive`
@@ -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)
-![](images/contribution/04-push.png) \ No newline at end of file
+![](images/contribution/04-push.png)
diff --git a/docs/project-file-structure.md b/docs/project-file-structure.md
index cf73b35..790ca76 100644
--- a/docs/project-file-structure.md
+++ b/docs/project-file-structure.md
@@ -34,10 +34,10 @@ All godot files are in the OpenVic/game directory
* 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 - OpenVic data file
-* ov2b - OpenVic 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 c48b5f6..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)
@@ -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>