From 603ac9ce4b1b46f6524f30fe1b7d8a87bd7576b3 Mon Sep 17 00:00:00 2001 From: erorcun Date: Tue, 12 May 2020 01:24:54 +0300 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cffdbd1d..7a4c8ea2 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,20 @@ such that we have a working game at all times. - (Optional) If you want to use optional features like Russian language or menu map, copy the files in /gamefiles folder to your game root folder. - Move re3.exe to GTA 3 directory and run it. +## How can I build it? + +Currently only building on VS2015/2017/2019 (Windows) and GCC (Linux) is tested. + +- Clone the repo. +- Run `git submodule init` and `git submodule update`. +- Point GTA_III_RE_DIR environment variable to GTA3 root folder. +- Run premake + - On Windows: one of the `premake-vsXXXX.cmd` variants on root folder + - On Linux: proceed to [Building on Linux](https://github.com/GTAmodding/re3/wiki/Building-on-Linux). +- There are various settings at the very bottom of [config.h](https://github.com/GTAmodding/re3/tree/master/src/core/config.h), you may want to take a look there. i.e. FIX_BUGS define fixes the bugs we've come across. + > :information_source: **Rendering engine** re3 uses completely homebrew RenderWare-replacement rendering engine; [librw](https://github.com/aap/librw/). librw comes as submodule of re3, but you also can use LIBRW enviorenment variable to specify path to your own librw. -> :warning: **Notice for builders** There are various settings at the very bottom of `config.h`, you may want to take a look there. i.e. FIX_BUGS define fixes the bugs we've come across. - -https://github.com/GTAmodding/re3/tree/master/src/core/config.h - ## Contributing ### Unreversed / incomplete classes (at least the ones we know) @@ -141,11 +149,3 @@ but here are some observations: * do *not* use `dw` for `DWORD` or so, we're not programming win32 * Generally, try to make the code look as if R* could have written it - -### Environment Variables -Here you can find a list of variables that you might need to set in windows: -``` -"GTA_III_RE_DIR" * path to "gta3_re" game folder usually where this plugin run. -"GTA_III_DIR" * path to "GTAIII" game folder. -"LIBRW" * path to LIBRW. -```