zone/OpenAssetTools
zone/OpenAssetTools
2
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2025-04-20 16:15:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #133 from Laupetin/docs/link-example-repos

Browse Source 
docs: link example repos
This commit is contained in:
Jan 2024-03-03 12:06:50 +01:00 committed by GitHub
commit 03647c4470
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -35,6 +35,9 @@ A full list of the subcomponents can be found [here](https://openassettools.dev/
## Using the tools ## Using the tools
Either download [the latest release from Github](https://github.com/Laupetin/OpenAssetTools/releases/latest) or [build OAT yourself](#building-oat). Either download [the latest release from Github](https://github.com/Laupetin/OpenAssetTools/releases/latest) or [build OAT yourself](#building-oat).
Building the tools yourself is only recommended if you want to do some changes to the code.
Otherwise you are probably better off just using the latest release.
You can put OAT anywhere, it does **not** need to be placed in your game folder. You can put OAT anywhere, it does **not** need to be placed in your game folder.
In fact i recommend against it to be able to better distinguish OAT files from game files. In fact i recommend against it to be able to better distinguish OAT files from game files.
@ -51,6 +54,19 @@ This project uses Premake to generate project files depending on your platform.
Note: The first time setting up will clone any submodules with git so the first initialization might take a bit. Note: The first time setting up will clone any submodules with git so the first initialization might take a bit.
## Documentation & Examples
The documentation can be found on the [OpenAssetTools.dev page](https://openassettools.dev).
It is hosted on Github Pages and its source can be found in the [OAT-Docs Repository](https://github.com/Laupetin/OAT-Docs).
For examples of mods that can be built with OAT you can either look into the [docs folder]() for some (currently very barebones) examples
or check out one of the following projects that are using OAT:
* [JezuzLizard/t6-fastfile-mods](https://github.com/JezuzLizard/t6-fastfile-mods)
* [Jbleezy/BO2-Reimagined](https://github.com/Jbleezy/BO2-Reimagined)
If you have a mod that you feel like would fit great here as well, feel free to open a PR to add it.
### Windows ### Windows
When building on Windows you will need to have Visual Studio 2022 installed. When building on Windows you will need to have Visual Studio 2022 installed.
@ -77,11 +93,6 @@ You now run `make` manually or use `./scripts/make_release.sh` or `./scripts/mak
The resulting binaries can be found in `build/bin/<Debug_x86|Release_x86>`. The resulting binaries can be found in `build/bin/<Debug_x86|Release_x86>`.
## Documentation
The documentation can be found on the [OpenAssetTools.dev page](https://openassettools.dev).
It is hosted on Github Pages and its source can be found in the [OAT-Docs Repository](https://github.com/Laupetin/OAT-Docs).
## Legal ## Legal
OAT source code is licensed under [GPLv3](./LICENSE). OAT source code is licensed under [GPLv3](./LICENSE).