-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2,418 changed files
with
41,103 additions
and
491 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,11 @@ | ||
# Practical Tools for Simple Design | ||
# Purpose | ||
|
||
###### Officially Supported Platforms and IDEs | ||
# Goal | ||
|
||
| | Windows | macOS | Linux | | ||
|:------------------------------:|:-------:|:-----:|:-----:| | ||
| CLion | V | V | V | | ||
| VSCode[^codeoss] | V | V | V | | ||
| Visual Studio[^novs][^vsmacos] | ? | X | X | | ||
| No IDE | V | V | V | | ||
# Methodology | ||
|
||
[^vsmacos]: [Microsoft Kills Visual Studio for Mac](https://visualstudiomagazine.com/articles/2023/08/30/vs-for-mac-retirement.aspx) | ||
[^codeoss]: On Linux the support of Code - OSS and VSCodium aren't guaranteed. | ||
[^novs]: Due to lack of testing there may or may not be more issues on VS. Anyway, building PTSD on VS is available. | ||
|
||
## Getting Started | ||
|
||
Required: Git, CMake, C/C++ Compiler, OpenGL Implementation | ||
|
||
Optional: Ninja Build, Clang | ||
|
||
> You might get some issue like https://github.com/ntut-open-source-club/practical-tools-for-simple-design/issues/78 check it if you need. | ||
### Command Line | ||
|
||
[//]: # (TODO: No IDE Quick Start) | ||
> [!WARNING] | ||
> This section is work in progress. | ||
``` | ||
git clone https://github.com/ntut-open-source-club/practical-tools-for-simple-design.git | ||
cd practical-tools-for-simple-design | ||
cmake -B build | ||
cmake --build build | ||
``` | ||
|
||
> If Ninja Build is install use `cmake -B build -G Ninja` to speed compile time | ||
> For older versions of CMake(`<3.13`? verification needed) use | ||
> ``` | ||
> mkdir build | ||
> cd build | ||
> cmake . | ||
> cmake --build . | ||
> ``` | ||
> if the `-B` flag is unsupported | ||
> If using Neovim or other LSP supported editors, append `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to the generation command for `clangd` to work | ||
### VSCode | ||
|
||
[//]: # (TODO: VSCode Quick Start) | ||
> [!WARNING] | ||
> This section is work in progress. | ||
### CLion | ||
|
||
[CLion Quick Start](.github/docs/CLionQuickStart/CLionQuickStart.md) | ||
|
||
###### NOTE: If you have time, read [OOP2023f Environment Setup](https://hackmd.io/@OOP2023f/rk2-8cVCh) | ||
|
||
## Generate Doxygen Documents | ||
|
||
Required: Doxygen 1.9.6 | ||
|
||
``` | ||
doxygen docs/Doxyfile | ||
``` | ||
|
||
Open the generated documents with your favorite browser at `docs/html/index.html` | ||
## Packages used | ||
1. openGL version 4.1 | ||
2. PTSD game Engine | ||
3. SDL2 | ||
4. Imgui |
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
MapFormat: 12 | ||
|
||
RequiresMod: ra | ||
|
||
Title: Name your map here | ||
|
||
Author: Your name here | ||
|
||
Tileset: TEMPERAT | ||
|
||
MapSize: 22,22 | ||
|
||
Bounds: 1,1,20,20 | ||
|
||
Visibility: Lobby | ||
|
||
Categories: Conquest | ||
|
||
Players: | ||
PlayerReference@Neutral: | ||
Name: Neutral | ||
OwnsWorld: True | ||
NonCombatant: True | ||
Faction: england | ||
PlayerReference@Creeps: | ||
Name: Creeps | ||
NonCombatant: True | ||
Faction: england | ||
|
||
Actors: |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
MapFormat: 12 | ||
|
||
RequiresMod: ra | ||
|
||
Title: test | ||
|
||
Author: Your name here | ||
|
||
Tileset: TEMPERAT | ||
|
||
MapSize: 4,4 | ||
|
||
Bounds: 1,1,2,2 | ||
|
||
Visibility: Lobby | ||
|
||
Categories: Conquest | ||
|
||
Players: | ||
PlayerReference@Neutral: | ||
Name: Neutral | ||
OwnsWorld: True | ||
NonCombatant: True | ||
Faction: england | ||
PlayerReference@Creeps: | ||
Name: Creeps | ||
NonCombatant: True | ||
Faction: england | ||
|
||
Actors: |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.