Skip to content

Commit bb3af02

Browse files
committed
Update README
1 parent 5f6d3f8 commit bb3af02

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# AdvancedCMakeTitanEngineExample
22

3-
This repository contains a minimal example of building a small application with the **Titan (Esenthel) Engine** using modern CMake. It accompanies the [blog post](https://medium.com/@drew.gilpin/esenthel-titan-engine-visual-studio-cmake-wsl-project-75da74e3d5b6) and can be built on both Windows and Linux.
4-
The project now builds two executables: a **client** sample and a **server** that hosts the ENet network.
3+
This repository contains an example of building a cross-platform application with the **Titan (Esenthel) Engine** using modern CMake. It accompanies the [blog post](https://medium.com/@drew.gilpin/advanced-esenthel-titan-engine-cmake-ddb85cb3803a) and can be built on both Windows and Linux.
4+
The project now builds two executables: a **client** sample and a **server** that hosts the ENet network (reliable UDP). It also includes unit tests using the Google Test framework, and a GitHub Actions workflow for building and testing on every push. The latest binary release is built with every push to master, which can be downloaded and ran without any installation. spdlog is included just as an additional example of using a third party library with CMake.
5+
6+
It is recommended to use CLion 2025.1.2+. This project was built ~80% by ChatGPT Codex.
57

68
## Preparing the engine files
79

@@ -17,24 +19,27 @@ third_party/EE/EngineDebug64DX11_pdb.zip-> third_party/EE/EngineDebug64DX11.pdb
1719

1820
## Building
1921

20-
CMake presets are provided for both platforms. **The Linux presets use Clang,**
21-
as the third-party Titan Engine headers rely on MSVC extensions not supported
22-
by GCC. Example commands:
22+
CMake presets are provided for both platforms. Example commands:
2323

2424
```bash
2525
cmake --preset linux-release # or windows-release
2626
cmake --build out/build/<preset>
2727
ctest --preset linux-test # run unit tests
2828
```
2929

30-
Both a client and server executable are produced. Their binaries and the required *.pak files will appear in
31-
`out/build/<preset>/apps/client/Bin` and `out/build/<preset>/apps/server/Bin`.
30+
Both a client and server executable are produced. Their binaries will appear in:
31+
32+
`out/build/<preset>/apps/client/` and `out/build/<preset>/apps/server/`
33+
34+
The required *.pak files will appear in:
35+
36+
`out/build/<preset>/apps/client/Bin` and `out/build/<preset>/apps/server/Bin`
3237

3338
## Running
3439

35-
1. Launch the server executable from its `Bin` directory.
40+
1. Launch the server executable from its directory.
3641
2. Then run the client executable which connects to the server on `127.0.0.1:12345`.
37-
The client will send a single test packet and both apps will display simple metrics.
42+
The client will connect both apps will display simple metrics, use the arrow keys to move the dot, which will sync from client<->server.
3843

3944
NB The engine headers and binaries here are subject to Esenthel / Titan Engine's license:
4045
### License

0 commit comments

Comments
 (0)