INSANEMODE/OpenAssetTools
1
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2025-06-10 14:58:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to reference docs website

Browse Source
This commit is contained in:
Jan
2023-11-04 17:55:07 +01:00
parent b73668c025
commit 116415d4b9
9 changed files with 17 additions and 2956 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -32,7 +32,16 @@ Only a subset of assets can be read from disk however, depending on the game.
Additionally, there are a couple of libraries and tools.
A full list of the subcomponents can be found [here](./docs/OatComponents.md).
## Getting started
## Using the tools
Either download [the latest release from Github](https://github.com/Laupetin/OpenAssetTools/releases/latest) or [build OAT yourself](#building-oat).
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.
For more information, check out the ["Getting started" guide in the OAT documentation](https://openassettools.dev/guide/getting-started.html).
You can find other useful guides and reference documentation there as well.
## Building OAT
You need to clone this repository using Git.
Do not download as a zip from Github because it will not be a git repository which is required for installing the submodules.
@ -68,10 +77,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>`.
## Using the tools
For information about how to use the tools see the ["Getting started" guide](docs/GettingStarted.md)
## Legal
OAT source code is licensed under [GPLv3](./LICENSE).