From eaec3c91fe1085fc8f0f7413f8a63b1af3c55bd3 Mon Sep 17 00:00:00 2001 From: AdventureT <35010415+AdventureT@users.noreply.github.com> Date: Thu, 9 Nov 2023 20:03:50 +0100 Subject: [PATCH] Create README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f773be --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# OpenJPOG +Decompilation of the Toshi engine 1.0 and Jurassic Park: Operation Genesis (JPOG). + +# **SUPPORT THE DEVELOPERS OF THE TOSHI ENGINE** +We do not own the Toshi Engine in any way, shape or form, and this project would not have been possible had they not developed TOSHI in the first place. The Toshi Engine is currently owned by [THQ Nordic](https://www.thqnordic.com); we highly urge you to follow & support their projects if you like this project! + +## **DO NOT USE THIS DECOMPILATION PROJECT AS A MEANS TO PIRATE JPOG OR ANY OTHER TOSHI GAMES.** +We do not condone using this project as a means for piracy in any form. This project was made with love and care for the source material and was created for purely educational purposes. + +## Building + +### Windows + +Building on Windows requires + +- Visual Studio 2019/2022 + +Clone the repository with the following commands: + + git clone https://github.com/AdventureT/OpenJPOG.git + cd OpenToshi + git submodule update --init --recursive + ./GenerateProjects-VS2019.bat (if you use Visual Studio 2019) + ./GenerateProjects-VS2022.bat (if you use Visual Studio 2022) + +Then compile the generated solution and that's it + +## Thirdparty libraries +- [catch2](https://github.com/catchorg/Catch2) +- [fmod](https://fmod.com/) +- [premake](https://github.com/premake/premake-core) +- [spdlog](https://github.com/gabime/spdlog) +- Fork of [theoraplay](https://github.com/InfiniteC0re/theoraplay)