# Saturn
This branch contains the code (albeit not clean considering I was never planning on making it open source) to build the last official/supported version of Saturn V3. This includes, but is not limited to, the file provider, plugin scripting language, plugin web API, and the item generators.

## What is Saturn?
Saturn is the most advanced Unreal Engine modding tool. We natively ship with the ability to mod Fortnite - as that is the most popular Unreal Engine game at the moment - but will provide help for modifying it towards another game. The UI is made in HTML, CSS, and JavaScript combining the smooth navigation of a website with the benefits of a native app.

Official Get-Started Page: NOT AVAILABLE YET

## How can I build this?

1. Install Git and CMake (both listed at the bottom of this README)
2. Clone the repo
```cmd
git clone https://github.com/Tamely/SaturnSwapper -b 3.0.0 --recursive
```
3. Navigate to the SaturnSwapper directory
```cmd
cd SaturnSwapper
```
4. Generate build files
```cmd
cmake -B build
```
5. Build the project
```cmd
cmake --build build --config MinSizeRel
```
6. Run the executable from the `/build/MinSizeRel/` directory

## Reporting security issues and security bugs

Security issues and bugs should be reported privately, via DM on Discord, to any Manager role holder in [Saturn's Discord](https://discord.gg/SaturnSwapper). You should receive a response within 24 hours. If - for whatever reason - you do not, please DM @tamely directly. You may be entitled to financial compensation for your report depending on the severity of the issue.

## Filing issues

This repo should contain issues that are tied to the actual codebase of the project. If a feature of the project is not working as intended, please use the `Support` channel in [Saturn's Discord](https://discord.gg/SaturnSwapper) to resolve your issue.

## Useful Links

* [Saturn's Discord](https://discord.gg/SaturnSwapper)
* [CMake Download](https://cmake.org/download/)
* [Git Download](https://gitforwindows.org/)

## License

Saturn is licensed under the [GNU General Public License v3.0](LICENSE)