From 72f73c8847ce8eeb2a2cfb2b2f07c670bec14f1f Mon Sep 17 00:00:00 2001 From: SpinnerX Date: Mon, 30 Mar 2026 23:05:29 -0700 Subject: [PATCH 1/6] Updated README to remove redundancies in wording and added specifications for dependencies and build specifications --- README.md | 45 ++++++++++++++++++++++++++++++++------------- 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 14479a11..76f1cf82 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,43 @@ Open-source Vulkan 3D game engine with native C++20 modules support. -Using **Conan** to manage our third party dependencies with Ninja + CMake for our build system. - Screenshot 2026-03-15 134559 -# Major Highlights +# 📦 Build System + +| Tool | Version | Description | +| :--- | :--- | :--- | +| **[CMake](https://www.glfw.org/)** | 4.0+ | Major build system for configuration and build generation | +| **[Ninja](https://github.com/g-truc/glm)** | 1.13+ | Small, high-speed build execution | +| **[Conan](https://github.com/ocornut/imgui)** | 2.23+ | C/C++ Package Manager for dependency resolution | + +# 🗺️ Project Dependencies + +These are dependencies to make it developing TheAtlasEngine possible + +| Library | Version | Description | +| :--- | :--- | :--- | +| **[GLFW](https://www.glfw.org/)** | 3.4+ | Multi-platform library for OpenGL, OpenGL ES, and Vulkan window/surface management. | +| **[GLM](https://github.com/g-truc/glm)** | 1.0.1+ | A header-only C++ mathematics library for graphics software based on GLSL specifications. | +| **[Dear ImGui](https://github.com/ocornut/imgui)** | 1.92.6+ | Bloat-free Immediate Mode Graphical User Interface for real-time tooling and debugging. | +| **[JoltPhysics](https://github.com/jrouwe/JoltPhysics)** | 5.5.0+ | Multi-core friendly rigid body physics and collision detection library. Written in C++ Suitable for games. | +| **[vulkan-cpp](https://github.com/engine3d-dev/vulkan-cpp)** | 6.0+ | Custom modern C++ abstraction layer using C++20 to develop and simplify using the Vulkan graphics API. | + +# 🧩 Major Highlights * HDRI Environment Map Support * Native Support for C++20 Modules * Interactive UI Editor * 3D Rigid Body Physics Simulation (Collisions, Shape Colliders) -# Setup Development Environment +# 🛠️ Setup Development Environment -New here? We use the C++ package manager, Conan. Follow the [Getting Started Guide](https://engine3d-dev.github.io/0.1/getting_started/) to setup your environment. +New here? Follow the [Getting Started](https://engine3d-dev.github.io/0.1/getting_started/) page to setup the dev environment. -## How to Build the Editor +## 🔩 Building the Project + +> [!TIP] +> `-s build_type=Debug` is recommended to compile the project as a Debug build for development. +> For development to disable the testing environment. Since there isn't a way to officially to building the editor. In the CMakeLists.txt file. @@ -31,17 +53,14 @@ Just uncomment the `editor` into your CMakeLists.txt file as shown in this examp add_subdirectory(editor) ``` -## Building the Project - -> [!TIP] -> `-s build_type=Debug` is recommended to compile the project as a Debug build for development. -> For development to disable the testing environment. +Then build using the following commands: ``` conan atlas build . -s build_type=Debug -o enable_tests_only=False ``` -## Executable Location + +## 💾 Executing the Editor After building TheAtlasEngine has been successful. Your executable will be executed via the following path layout. @@ -54,7 +73,7 @@ Example on Windows, you'd execute the executable in the terminal as: .\build\Debug\editor\editor.exe ``` -# Games Built using TheAtlasEngine +# 🎮 Games Built using TheAtlasEngine These are games that have been built by me and others to showcase the capabilities of the game engine. Demonstrating capabilities and progression made by the team. From b1705b8b6f6f472f969ad0becbe79ca9eb6985a4 Mon Sep 17 00:00:00 2001 From: SpinnerX Date: Mon, 30 Mar 2026 23:08:09 -0700 Subject: [PATCH 2/6] Small README update --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 76f1cf82..d8cd79b0 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Open-source Vulkan 3D game engine with native C++20 modules support. Screenshot 2026-03-15 134559 -# 📦 Build System +## 📦 Build System | Tool | Version | Description | | :--- | :--- | :--- | @@ -17,7 +17,7 @@ Open-source Vulkan 3D game engine with native C++20 modules support. | **[Ninja](https://github.com/g-truc/glm)** | 1.13+ | Small, high-speed build execution | | **[Conan](https://github.com/ocornut/imgui)** | 2.23+ | C/C++ Package Manager for dependency resolution | -# 🗺️ Project Dependencies +## 🗺️ Project Dependencies These are dependencies to make it developing TheAtlasEngine possible @@ -29,17 +29,17 @@ These are dependencies to make it developing TheAtlasEngine possible | **[JoltPhysics](https://github.com/jrouwe/JoltPhysics)** | 5.5.0+ | Multi-core friendly rigid body physics and collision detection library. Written in C++ Suitable for games. | | **[vulkan-cpp](https://github.com/engine3d-dev/vulkan-cpp)** | 6.0+ | Custom modern C++ abstraction layer using C++20 to develop and simplify using the Vulkan graphics API. | -# 🧩 Major Highlights +## 🧩 Major Highlights * HDRI Environment Map Support * Native Support for C++20 Modules * Interactive UI Editor * 3D Rigid Body Physics Simulation (Collisions, Shape Colliders) -# 🛠️ Setup Development Environment +## 🛠️ Setup Development Environment New here? Follow the [Getting Started](https://engine3d-dev.github.io/0.1/getting_started/) page to setup the dev environment. -## 🔩 Building the Project +### 🔩 Building the Project > [!TIP] > `-s build_type=Debug` is recommended to compile the project as a Debug build for development. @@ -60,7 +60,7 @@ conan atlas build . -s build_type=Debug -o enable_tests_only=False ``` -## 💾 Executing the Editor +### 💾 Executing the Editor After building TheAtlasEngine has been successful. Your executable will be executed via the following path layout. @@ -73,7 +73,7 @@ Example on Windows, you'd execute the executable in the terminal as: .\build\Debug\editor\editor.exe ``` -# 🎮 Games Built using TheAtlasEngine +## 🎮 Games Built using TheAtlasEngine These are games that have been built by me and others to showcase the capabilities of the game engine. Demonstrating capabilities and progression made by the team. From 2860484b57f3687ca04b04e1b4229f210b933610 Mon Sep 17 00:00:00 2001 From: SpinnerX Date: Mon, 30 Mar 2026 23:15:41 -0700 Subject: [PATCH 3/6] Fixed more wordings in the README --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d8cd79b0..bac66b35 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,12 @@ Open-source Vulkan 3D game engine with native C++20 modules support. Screenshot 2026-03-15 134559 +## 🧩 Major Highlights +* HDRI Environment Map Support +* Native Support for C++20 Modules +* Interactive UI Editor +* 3D Rigid Body Physics Simulation (Collisions, Shape Colliders) + ## 📦 Build System | Tool | Version | Description | @@ -29,12 +35,6 @@ These are dependencies to make it developing TheAtlasEngine possible | **[JoltPhysics](https://github.com/jrouwe/JoltPhysics)** | 5.5.0+ | Multi-core friendly rigid body physics and collision detection library. Written in C++ Suitable for games. | | **[vulkan-cpp](https://github.com/engine3d-dev/vulkan-cpp)** | 6.0+ | Custom modern C++ abstraction layer using C++20 to develop and simplify using the Vulkan graphics API. | -## 🧩 Major Highlights -* HDRI Environment Map Support -* Native Support for C++20 Modules -* Interactive UI Editor -* 3D Rigid Body Physics Simulation (Collisions, Shape Colliders) - ## 🛠️ Setup Development Environment New here? Follow the [Getting Started](https://engine3d-dev.github.io/0.1/getting_started/) page to setup the dev environment. @@ -75,22 +75,20 @@ Example on Windows, you'd execute the executable in the terminal as: ## 🎮 Games Built using TheAtlasEngine -These are games that have been built by me and others to showcase the capabilities of the game engine. Demonstrating capabilities and progression made by the team. +These games were build by me (Aaron) and others to demonstrate the earlier capabilities of TheAtlasEngine made by the team. > [!NOTE] -> TheAtlasEngine is quite early in its development, therefore some of the games may be buggy or have missing features in the games released. -> We believe to test the capabilities of TheAtlasEngine is to continue and building games with it by participating in game jams to learn what works for the project. - +> TheAtlasEngine was quite early in its development when these games were first built, therefore having some definite flaws and missing features. +> We believe being able to build games and continue participating in game jams will help us continue to learn what works best for TheAtlasEngine. ## Monkey Ball -### Description This was the first game that we made with TheAtlasEngine when the project first started. This was for the SFSU Game Development Club's end of the semester showcase of Fall 2024 Screenshot 2025-12-06 025821 ## Wallace and Grommit Rocket Game -### Description + Developed during the SFSU Game Dev Club Spring 2025 Game Jam, this project serves as a technical demonstration of TheAtlasEngine core capabilities. Inspired by similar projects from creators like TheCherno -- to test the game engine's capabilities. * [itch.io link](https://niccoll-dyson.itch.io/wallace-and-grommit-spaceship-game) to out game jam submission From 5229d6204d647f4bd881bb6d4f97b8e699d584d4 Mon Sep 17 00:00:00 2001 From: SpinnerX Date: Mon, 30 Mar 2026 23:23:39 -0700 Subject: [PATCH 4/6] Fixed some README wording for the game sections --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bac66b35..c8a4bff6 100644 --- a/README.md +++ b/README.md @@ -83,15 +83,15 @@ These games were build by me (Aaron) and others to demonstrate the earlier capab ## Monkey Ball -This was the first game that we made with TheAtlasEngine when the project first started. This was for the SFSU Game Development Club's end of the semester showcase of Fall 2024 +This Monkey Ball game was the first ever game built using TheAtlasEngine, in its the early development. This game was for the SFSU Game Development Club's end of the semester showcase of Fall 2024. Screenshot 2025-12-06 025821 ## Wallace and Grommit Rocket Game -Developed during the SFSU Game Dev Club Spring 2025 Game Jam, this project serves as a technical demonstration of TheAtlasEngine core capabilities. Inspired by similar projects from creators like TheCherno -- to test the game engine's capabilities. +This game was developed during the SFSU Game Dev Club Spring 2025 Game Jam, this project serves as a demonstration of TheAtlasEngine earlier capabilities. Inspired by similar projects from youtube creators like TheCherno. -* [itch.io link](https://niccoll-dyson.itch.io/wallace-and-grommit-spaceship-game) to out game jam submission -* GitHub [repository link](https://github.com/SpinnerX/3d-rocket-game) +* [itch.io link](https://niccoll-dyson.itch.io/wallace-and-grommit-spaceship-game) to checkout the game jam submission. +* GitHub [repository](https://github.com/SpinnerX/3d-rocket-game) link. ![Screenshot 2025-03-03 010511](https://github.com/user-attachments/assets/f3758e33-8d4b-4fa8-af08-167bca14037f) From 64e1cc46a4cf0a9f64bcc92a7229eddcfdfe5ba3 Mon Sep 17 00:00:00 2001 From: SpinnerX Date: Mon, 30 Mar 2026 23:38:43 -0700 Subject: [PATCH 5/6] Updated referral links for build system sections --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c8a4bff6..5a022a39 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # The Atlas Engine - +[![C++](https://img.shields.io/badge/C%2B%2B-20%2F23-blue)]() [![✅CI](https://github.com/engine3d-dev/TheAtlasEngine/actions/workflows/clang-format-deploy.yml/badge.svg)](https://github.com/engine3d-dev/TheAtlasEngine/actions/workflows/clang-format-deploy.yml) [![GitHub stars](https://img.shields.io/github/stars/engine3d-dev/TheAtlasEngine.svg)](https://github.com/engine3d-dev/TheAtlasEngine/stargazers) [![GitHub forks](https://img.shields.io/github/forks/engine3d-dev/TheAtlasEngine.svg)](https://github.com/engine3d-dev/TheAtlasEngine/network) @@ -19,9 +19,9 @@ Open-source Vulkan 3D game engine with native C++20 modules support. | Tool | Version | Description | | :--- | :--- | :--- | -| **[CMake](https://www.glfw.org/)** | 4.0+ | Major build system for configuration and build generation | -| **[Ninja](https://github.com/g-truc/glm)** | 1.13+ | Small, high-speed build execution | -| **[Conan](https://github.com/ocornut/imgui)** | 2.23+ | C/C++ Package Manager for dependency resolution | +| **[CMake](https://cmake.org/)** | 4.0+ | Major build system for configuration and build generation | +| **[Ninja](https://ninja-build.org/)** | 1.13+ | Small, high-speed build execution | +| **[Conan](https://conan.io/)** | 2.23+ | C/C++ Package Manager for dependency resolution | ## 🗺️ Project Dependencies From 024951014b6e02f2b85e2fceaed65ffa4072a09d Mon Sep 17 00:00:00 2001 From: SpinnerX Date: Mon, 30 Mar 2026 23:40:36 -0700 Subject: [PATCH 6/6] Commented C++ badge for readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a022a39..abaee0cc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # The Atlas Engine -[![C++](https://img.shields.io/badge/C%2B%2B-20%2F23-blue)]() + [![✅CI](https://github.com/engine3d-dev/TheAtlasEngine/actions/workflows/clang-format-deploy.yml/badge.svg)](https://github.com/engine3d-dev/TheAtlasEngine/actions/workflows/clang-format-deploy.yml) [![GitHub stars](https://img.shields.io/github/stars/engine3d-dev/TheAtlasEngine.svg)](https://github.com/engine3d-dev/TheAtlasEngine/stargazers) [![GitHub forks](https://img.shields.io/github/forks/engine3d-dev/TheAtlasEngine.svg)](https://github.com/engine3d-dev/TheAtlasEngine/network)