From 2e3d5162f7277f277079c5129678e765ff054daa Mon Sep 17 00:00:00 2001 From: Sergeanur Date: Fri, 27 Nov 2020 18:33:59 +0200 Subject: [PATCH] Readme update --- README.md | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ef850f59..8d29ba56 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# re3 -[![Build status](https://ci.appveyor.com/api/projects/status/hyiwgegks122h8jg/branch/master?svg=true)](https://ci.appveyor.com/project/aap/re3/branch/master) +# reVC +[![Build status](https://ci.appveyor.com/api/projects/status/hyiwgegks122h8jg/branch/miami?svg=true)](https://ci.appveyor.com/project/aap/re3/branch/miami) | Platform | Debug | Release | |------------------|-------------|-------------| @@ -8,16 +8,14 @@ ## Intro -The aim of this project is to reverse GTA III for PC by replacing -parts of the game [one by one](https://en.wikipedia.org/wiki/Ship_of_Theseus) -such that we have a working game at all times. +The aim of this project is to reverse GTA Vice City for PC. ## How can I try it? -- re3 requires game assets to work, so you **must** own [a copy of GTA III](https://store.steampowered.com/app/12100/Grand_Theft_Auto_III/). -- Build re3 or download it from one of the above links (Debug or Release). -- (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. +- reVC requires game assets to work, so you **must** own [a copy of GTA Vice City](https://store.steampowered.com/app/12110/Grand_Theft_Auto_Vice_City/). +- Build reVC or download it from one of the above links (Debug or Release). +- (Optional) If you want to use optional features, copy the files in /gamefiles folder to your game root folder. +- Move reVC.exe to GTA VC directory and run it. ## Preparing the environment for building @@ -32,19 +30,15 @@ You may want to point GTA_VC_RE_DIR environment variable to GTA VC root folder i **If you use 64-bit D3D9**: We don't ship 64-bit Dx9 SDK. You need to download it from Microsoft if you don't have it(although it should come pre-installed after some Windows version) -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. +There are various settings at the very bottom of [config.h](https://github.com/GTAmodding/re3/tree/miami/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: **If you choose OpenAL on Windows** You must read [Running OpenAL build on Windows](https://github.com/GTAmodding/re3/wiki/Running-OpenAL-build-on-Windows). -> :information_source: **Did you notice librw?** 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. +> :information_source: **Did you notice librw?** reVC uses completely homebrew RenderWare-replacement rendering engine; [librw](https://github.com/aap/librw/). librw comes as submodule of reVC, but you also can use LIBRW enviorenment variable to specify path to your own librw. ## Contributing Please read the [Coding Style](https://github.com/GTAmodding/re3/blob/master/CODING_STYLE.md) Document ### Unreversed / incomplete classes (at least the ones we know) -The following classes have only unused or practically unused code left: -``` -CCullZone - only mobile stuff -CCullZones - only mobile stuff -``` +See [VC todo list](https://github.com/GTAmodding/re3/wiki/VC-todo)