From f48232cc1d768dfa46b0c60b7e49cf726b92b126 Mon Sep 17 00:00:00 2001 From: Orange Date: Sat, 13 Sep 2025 19:50:58 +0300 Subject: [PATCH] Updates README with gallery, install and usage Enhances the README by adding a gallery showcasing OMath's capabilities, providing a clearer installation guide, and improving usage examples to facilitate easier adoption. Also restructures the navigation for better user experience. --- .github/images/yt_previews/img.png | 3 ++ README.md | 63 ++++++++++++++++++++---------- 2 files changed, 45 insertions(+), 21 deletions(-) create mode 100644 .github/images/yt_previews/img.png diff --git a/.github/images/yt_previews/img.png b/.github/images/yt_previews/img.png new file mode 100644 index 0000000..8cc4f93 --- /dev/null +++ b/.github/images/yt_previews/img.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6fb12292a019445f455269af9b42daf7fe7265e2b581c3927e71103279337fad +size 1521998 diff --git a/README.md b/README.md index f0a2639..87f6bd1 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,17 @@ OMath is a 100% independent, constexpr template blazingly fast math library that doesn't have legacy C++ code. It provides the latest features, is highly customizable, has all for cheat development, DirectX/OpenGL/Vulkan support, premade support for different game engines, much more constexpr stuff than in other libraries and more... +
+
+ +--- + +**[
Install
][INSTALL]** +**[
Examples
][EXAMPLES]** +**[
Contribute
][CONTRIBUTING]** +--- + +
@@ -39,6 +50,27 @@ It provides the latest features, is highly customizable, has all for cheat devel - **No Additional Dependencies**: No additional dependencies need to use OMath except unit test execution - **Ready for meta-programming**: Omath use templates for common types like Vectors, Matrixes etc, to handle all types! +# Gallery + +
+ +![APEX Preview] + +
+ +![BO2 Preview] + +
+ +![CS2 Preview] + +[![Youtube Video](.github/images/yt_previews/img.png)](https://youtu.be/lM_NJ1yCunw?si=-Qf5yzDcWbaxAXGQ) +
+
+ + + + ## Supported Render Pipelines | ENGINE | SUPPORT | |----------|---------| @@ -56,9 +88,6 @@ It provides the latest features, is highly customizable, has all for cheat devel | Linux | βœ…YES | | Darwin (MacOS) | βœ…YES | -## ⏬ Installation -Please read our [installation guide](https://github.com/orange-cpp/omath/blob/main/INSTALL.md). If this link doesn't work check out INSTALL.md file. - ## ❔ Usage ESP example ```c++ @@ -80,24 +109,16 @@ for (auto ent: apex_sdk::EntityList::GetAllEntities()) // esp rendering... } ``` -## Showcase - -With `omath/projection` module you can achieve simple ESP hack for powered by Source/Unreal/Unity engine games, like [Apex Legends](https://store.steampowered.com/app/1172470/Apex_Legends/). - -![banner](.github/images/showcase/apex.png) -Or for InfinityWard Engine based games. Like Call of Duty Black Ops 2! -![banner](.github/images/showcase/cod_bo2.png) -Or create simple trigger bot with embeded traceline from omath::collision::LineTrace -![banner](.github/images/showcase/cs2.jpeg) -Or even advanced projectile aimbot -[Watch Video](https://youtu.be/lM_NJ1yCunw?si=5E87OrQMeypxSJ3E) - - -## 🫡🏻 Contributing -Contributions to `omath` are welcome! Please read `CONTRIBUTING.md` for details on our code of conduct and the process for submitting pull requests. - -## πŸ“œ License -This project is licensed under the ZLIB - see the `LICENSE` file for details. ## πŸ’˜ Acknowledgments - [All contributors](https://github.com/orange-cpp/omath/graphs/contributors) + + +[APEX Preview]: .github/images/showcase/apex.png +[BO2 Preview]: .github/images/showcase/cod_bo2.png +[CS2 Preview]: .github/images/showcase/cs2.jpeg + + +[INSTALL]: INSTALL.md +[CONTRIBUTING]: CONTRIBUTING.md +[EXAMPLES]: examples