mirror of
https://github.com/GTAmodding/re3.git
synced 2024-11-30 00:45:40 +00:00
ff057838ec
* 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
47 lines
2.5 KiB
Markdown
47 lines
2.5 KiB
Markdown
# reLCS
|
|
[](https://actions-badge.atrox.dev/GTAmodding/re3/goto?ref=lcs)
|
|
<a href="https://discord.gg/aKYAwCx92H"><img src="https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat" /></a>
|
|
|
|
## 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](https://github.com/GTAmodding/re3/wiki/Building-on-Linux)
|
|
- For FreeBSD, proceed: [Building on FreeBSD](https://github.com/GTAmodding/re3/wiki/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](https://github.com/GTAmodding/re3/tree/lcs/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?** reLCS uses completely homebrew RenderWare-replacement rendering engine; [librw](https://github.com/aap/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](https://github.com/GTAmodding/re3/blob/master/CODING_STYLE.md) 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
|
|
|