Skip to content

Commit d37840d

Browse files
orange-cpporange-cpp
committed
fixed stuff
1 parent b4a3b5d commit d37840d

File tree

5 files changed

+211
-21
lines changed

5 files changed

+211
-21
lines changed

‎writerside/o.tree‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
<toc-element topic="starter-topic.md"/>
1010
<toc-element topic="Documentation.md"/>
11+
<toc-element topic="Code-Of-Conduct.md"/>
1112
<toc-element topic="Community.md"/>
1213
<toc-element topic="License.md"/>
1314
</instance-profile>

‎writerside/topics/Code-Of-Conduct.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Code Of Conduct
2+
3+
## 🎯 Goal
4+
5+
My goal is to provide a space where it is safe for everyone to contribute to,
6+
and get support for, open-source software in a respectful and cooperative
7+
manner.
8+
9+
I value all contributions and want to make this project and its
10+
surrounding community a place for everyone.
11+
12+
As members, contributors, and everyone else who may participate in the
13+
development, I strive to keep the entire experience civil.
14+
15+
## 📜 Standards
16+
17+
Our community standards exist in order to make sure everyone feels comfortable
18+
contributing to the project(s) together.
19+
20+
Our standards are:
21+
- Do not harass, attack, or in any other way discriminate against anyone, including
22+
for their protected traits, including, but not limited to, sex, religion, race,
23+
appearance, gender, identity, nationality, sexuality, etc.
24+
- Do not go off-topic, do not post spam.
25+
- Treat everyone with respect.
26+
27+
Examples of breaking each rule respectively include:
28+
- Harassment, bullying or inappropriate jokes about another person.
29+
- Posting distasteful imagery, trolling, or posting things unrelated to the topic at hand.
30+
- Treating someone as worse because of their lack of understanding of an issue.
31+
32+
## ⚡ Enforcement
33+
34+
Enforcement of this CoC is done by Orange++ and/or other core contributors.
35+
36+
I, as the core developer, will strive my best to keep this community civil and
37+
following the standards outlined above.
38+
39+
### 🚩 Reporting incidents
40+
41+
If you believe an incident of breaking these standards has occurred, but nobody has
42+
taken appropriate action, you can privately contact the people responsible for dealing
43+
with such incidents in multiple ways:
44+
45+
***E-Mail***
46+
- `[email protected]`
47+
48+
***Discord***
49+
- `@orange_cpp`
50+
51+
***Telegram***
52+
- `@orange_cpp`
53+
54+
I guarantee your privacy and will not share those reports with anyone.
55+
56+
## ⚖️ Enforcement Strategy
57+
58+
Depending on the severity of the infraction, any action from the list below may be applied.
59+
Please keep in mind cases are reviewed on a per-case basis and members are the ultimate
60+
deciding factor in the type of punishment.
61+
62+
If the matter benefited from an outside opinion, a member might reach for more opinions
63+
from people unrelated, however, the final decision regarding the action
64+
to be taken is still up to the member.
65+
66+
For example, if the matter at hand regards a representative of a marginalized group or minority,
67+
the member might ask for a first-hand opinion from another representative of such group.
68+
69+
### ✏️ Correction/Edit
70+
71+
If your message is found to be misleading or poorly worded, a member might
72+
edit your message.
73+
74+
### ⚠️ Warning/Deletion
75+
76+
If your message is found inappropriate, a member might give you a public or private warning,
77+
and/or delete your message.
78+
79+
### 🔇 Mute
80+
81+
If your message is disruptive, or you have been repeatedly violating the standards,
82+
a member might mute (or temporarily ban) you.
83+
84+
### ⛔ Ban
85+
86+
If your message is hateful, very disruptive, or other, less serious infractions are repeated
87+
ignoring previous punishments, a member might ban you permanently.
88+
89+
## 🔎 Scope
90+
91+
This CoC shall apply to all projects ran under the Orange++ lead and all _official_ communities
92+
outside of GitHub.
93+
94+
However, it is worth noting that official communities outside of GitHub might have their own,
95+
additional sets of rules.

‎writerside/topics/Community.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
# Community
1+
# Credits
22

3-
Start typing here...
3+
Thanks to everyone who made this possible, including:
4+
5+
- Saikari aka luadebug for VCPKG port.
6+
7+
And a big hand to everyone else who has contributed over the past!
8+
9+
THANKS! <3
10+
11+
-- Orange++ <[email protected]>

‎writerside/topics/Documentation.md‎

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
1-
# Documentation
1+
# 📥Installation Guide
22

3-
Start typing here...
3+
## Using vcpkg
4+
**Note**: Support vcpkg for package management
5+
1. Install [vcpkg](https://github.com/microsoft/vcpkg)
6+
2. Run the following command to install the orange-math package:
7+
```
8+
vcpkg install orange-math
9+
```
10+
CMakeLists.txt
11+
```cmake
12+
find_package(omath CONFIG REQUIRED)
13+
target_link_libraries(main PRIVATE omath::omath)
14+
```
15+
For detailed commands on installing different versions and more information, please refer to Microsoft's [official instructions](https://learn.microsoft.com/en-us/vcpkg/get_started/overview).
16+
17+
## Build from source using CMake
18+
1. **Preparation**
19+
20+
Install needed tools: cmake, clang, git, msvc (windows only).
21+
22+
1. **Linux:**
23+
```bash
24+
sudo pacman -Sy cmake ninja clang git
25+
```
26+
2. **MacOS:**
27+
```bash
28+
brew install llvm git cmake ninja
29+
```
30+
3. **Windows:**
31+
32+
Install Visual Studio from [here](https://visualstudio.microsoft.com/downloads/) and Git from [here](https://git-scm.com/downloads).
33+
34+
Use x64 Native Tools shell to execute needed commands down below.
35+
2. **Clone the repository:**
36+
```bash
37+
git clone https://github.com/orange-cpp/omath.git
38+
```
39+
3. **Navigate to the project directory:**
40+
```bash
41+
cd omath
42+
```
43+
4. **Build the project using CMake:**
44+
```bash
45+
cmake --preset windows-release -S .
46+
cmake --build cmake-build/build/windows-release --target omath -j 6
47+
```
48+
Use **\<platform\>-\<build configuration\>** preset to build siutable version for yourself. Like **windows-release** or **linux-release**.
49+
50+
| Platform Name | Build Config |
51+
|---------------|---------------|
52+
| windows | release/debug |
53+
| linux | release/debug |
54+
| darwin | release/debug |

‎writerside/topics/starter-topic.md‎

Lines changed: 52 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Introduction
1+
# Intro
2+
3+
![banner](https://i.imgur.com/SM9ccP6.png)
24

35
Oranges's Math Library (omath) is a comprehensive, open-source library aimed at providing efficient, reliable, and versatile mathematical functions and algorithms. Developed primarily in C++, this library is designed to cater to a wide range of mathematical operations essential in scientific computing, engineering, and academic research.
46

5-
## Features
7+
## 👁‍🗨 Features
68
- **Efficiency**: Optimized for performance, ensuring quick computations using AVX2.
79
- **Versatility**: Includes a wide array of mathematical functions and algorithms.
810
- **Ease of Use**: Simplified interface for convenient integration into various projects.
@@ -12,21 +14,54 @@ Oranges's Math Library (omath) is a comprehensive, open-source library aimed at
1214
- **No Additional Dependencies**: No additional dependencies need to use OMath except unit test execution
1315
- **Ready for meta-programming**: Omath use templates for common types like Vectors, Matrixes etc, to handle all types!
1416

15-
| ENGINE | SUPPORT |
16-
|:--------:|:-------:|
17-
| Source | ✅YES |
18-
| Unity | ✅YES |
19-
| IWEngine | ✅YES |
20-
| Unreal | ❌NO |
17+
## Supported Render Pipelines
18+
| ENGINE | SUPPORT |
19+
|----------|---------|
20+
| Source | ✅YES |
21+
| Unity | ✅YES |
22+
| IWEngine | ✅YES |
23+
| Unreal | ❌NO |
2124

25+
## Supported Operating Systems
2226

23-
## Acknowledgments
24-
We value each person that made pull request to this project! And YOU can become one of them!
25-
- [All contributors](https://github.com/orange-cpp/omath/graphs/contributors)
26-
<seealso>
27-
<category name="Related topics" ref="inf">
28-
<a href="https://github.com/orange-cpp/omath">GitHub repository</a>
29-
<a href="https://yougame.biz/threads/332534">YouGame thread</a>
30-
</category>
31-
</seealso>
27+
| OS | SUPPORT |
28+
|----------------|---------|
29+
| Windows 10/11 | ✅YES |
30+
| Linux | ✅YES |
31+
| Darwin (MacOS) | ✅YES |
32+
33+
## ⏬ Installation
34+
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.
35+
36+
## ❔ Usage
37+
Simple world to screen function
38+
```c++
39+
TEST(UnitTestProjection, IsPointOnScreen)
40+
{
41+
const omath::projection::Camera camera({0.f, 0.f, 0.f}, {0, 0.f, 0.f} , {1920.f, 1080.f}, 110.f, 0.1f, 500.f);
42+
43+
const auto proj = camera.WorldToScreen({100, 0, 15});
44+
EXPECT_TRUE(proj.has_value());
45+
}
46+
```
47+
## Showcase
48+
49+
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/).
3250
51+
![banner](https://i.imgur.com/lcJrfcZ.png)
52+
Or for InfinityWard Engine based games. Like Call of Duty Black Ops 2!
53+
![banner](https://i.imgur.com/F8dmdoo.png)
54+
Or create simple trigger bot with embeded traceline from omath::collision::LineTrace
55+
![banner](https://i.imgur.com/fxMjRKo.jpeg)
56+
Or even advanced projectile aimbot
57+
[Watch Video](https://youtu.be/lM_NJ1yCunw?si=5E87OrQMeypxSJ3E)
58+
59+
60+
## 🫵🏻 Contributing
61+
Contributions to `omath` are welcome! Please read `CONTRIBUTING.md` for details on our code of conduct and the process for submitting pull requests.
62+
63+
## 📜 License
64+
This project is licensed under the MIT - see the `LICENSE` file for details.
65+
66+
## 💘 Acknowledgments
67+
- [All contributors](https://github.com/orange-cpp/omath/graphs/contributors)

0 commit comments

Comments
 (0)