re3/README.md

38 lines
2.3 KiB
Markdown
Raw Normal View History

2021-02-16 17:38:43 +00:00
# reLCS
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FGTAmodding%2Fre3%2Fbadge%3Fref%3Dlcs&style=flat)](https://actions-badge.atrox.dev/GTAmodding/re3/goto?ref=lcs)
2021-06-25 13:24:26 +00:00
<a href="https://discord.gg/RFNbjsUMGg"><img src="https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat" /></a>
2019-11-06 22:53:54 +00:00
## Intro
2019-05-15 14:52:37 +00:00
2021-02-16 17:38:43 +00:00
The aim of this project is to reverse GTA Liberty City Stories.
2020-05-11 22:24:54 +00:00
2021-02-11 23:57:39 +00:00
## How can I try it?
2020-11-26 21:41:29 +00:00
2021-02-16 17:38:43 +00:00
- 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.
2021-02-03 20:40:04 +00:00
2021-02-16 17:38:43 +00:00
## Preparing the environment for building
2021-02-03 20:40:04 +00:00
2021-02-16 17:38:43 +00:00
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.
2021-02-03 20:40:04 +00:00
2021-02-16 17:38:43 +00:00
- 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
2020-11-26 21:41:29 +00:00
2021-02-16 17:38:43 +00:00
**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)
2020-07-22 12:21:51 +00:00
2021-02-16 17:38:43 +00:00
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.
2021-02-14 02:11:52 +00:00
2021-02-16 17:38:43 +00:00
> :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).
2021-02-14 02:11:52 +00:00
2021-02-16 17:38:43 +00:00
> :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.
2019-05-29 22:47:33 +00:00
2020-04-17 15:30:59 +00:00
## Contributing
2021-02-16 17:38:43 +00:00
Please read the [Coding Style](https://github.com/GTAmodding/re3/blob/master/CODING_STYLE.md) Document
2020-04-07 14:48:49 +00:00