re3/README.md
Sergeanur ff057838ec Merge branch 'miami' into lcs
* miami:
  Fix backface culling of cutscene objects
  more renames
  anim velocity union
  rename m_vehEnterType -> m_vehDoor
  Port cmake improvements to miami
  some loose ends
  move TODO to Readme
  Fix build without FIX_BUGS, divide to 0 fixes
2021-01-13 14:56:25 +02:00

2.5 KiB
Raw Blame History

reLCS

Build Status

Intro

The aim of this project is to reverse GTA Liberty City Stories.

How can I try it?

  • reLCS requires game assets to work.
  • Build reLCS 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 reLCS.exe to GTA LCS directory and run it.

Preparing the environment for building

You may want to point GTA_LCS_RE_DIR environment variable to GTA LCS root folder if you want executable to be moved there via post-build script.

  • For Linux, proceed: Building on Linux
  • For FreeBSD, proceed: Building on FreeBSD
  • For Windows, assuming you have Visual Studio:
    • Clone the repo using the argument --recursive.
    • Run one of the premake-vsXXXX.cmd variants on root folder.
    • Open the project via Visual Studio

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, you may want to take a look there. i.e. FIX_BUGS define fixes the bugs we've come across.

If you choose OpenAL on Windows You must read Running OpenAL build on Windows.

Did you notice librw? reLCS uses completely homebrew RenderWare-replacement rendering engine; librw. librw comes as submodule of reLCS, but you also can use LIBRW enviorenment variable to specify path to your own librw.

Contributing

Please read the Coding Style Document

Unreversed / incomplete classes

PS2/Mobile stuff:

src/core/Pad.cpp
src/core/main.cpp
src/core/Frontend_PS2.cpp
src/core/FrontEndControls.cpp
src/save/MemoryCard.cpp