diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..f458bd43
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,13 @@
+As long as it's not linux/cross-platform skeleton/compatibility layer, all of the code on the repo that's not behind a preprocessor condition(like FIX_BUGS) are **completely** reversed code from original binaries.
+
+We **don't** accept custom codes, as long as it's not wrapped via preprocessor conditions, or it's linux/cross-platform skeleton/compatibility layer.
+
+We accept only these kinds of PRs;
+
+- A new feature that exists in at least one of the GTAs (if it wasn't in III/VC then it doesn't have to be decompilation)
+- Game, UI or UX bug fixes (if it's a fix to R* code, it should be behind FIX_BUGS)
+- Platform-specific and/or unused code that's not been reversed yet
+- Makes reversed code more understandable/accurate, as in "which code would produce this assembly".
+- A new cross-platform skeleton/compatibility layer, or improvements to them
+- Translation fixes, for languages R* supported/outsourced
+- Code that increase maintainability
diff --git a/.github/workflows/build-cmake-conan.yml b/.github/workflows/build-cmake-conan.yml
deleted file mode 100644
index acbad81c..00000000
--- a/.github/workflows/build-cmake-conan.yml
+++ /dev/null
@@ -1,116 +0,0 @@
-name: reVC conan+cmake
-on:
- pull_request:
- push:
- release:
- types: published
-jobs:
- build-cmake:
- strategy:
- matrix:
- include:
- - os: 'windows-latest'
- platform: 'gl3'
- gl3_gfxlib: 'glfw'
- audio: 'openal'
-# - os: 'windows-latest'
-# platform: 'gl3'
-# gl3_gfxlib: 'sdl2'
-# audio: 'openal'
- - os: 'windows-latest'
- platform: 'd3d9'
- audio: 'openal'
-# - os: 'windows-latest'
-# platform: 'd3d9'
-# audio: 'miles'
- - os: 'ubuntu-latest'
- platform: 'gl3'
- gl3_gfxlib: 'glfw'
- audio: 'openal'
-# - os: 'ubuntu-latest'
-# platform: 'gl3'
-# gl3_gfxlib: 'sdl2'
-# audio: 'openal'
- - os: 'macos-latest'
- platform: 'gl3'
- gl3_gfxlib: 'glfw'
- audio: 'openal'
-# - os: 'macos-latest'
-# platform: 'gl3'
-# gl3_gfxlib: 'sdl2'
-# audio: 'openal'
- runs-on: ${{ matrix.os }}
- continue-on-error: ${{ matrix.platform == 'ps2' || matrix.gl3_gfxlib == 'sdl2' || matrix.audio == 'miles' }}
- steps:
- - uses: actions/checkout@v2
- with:
- submodules: true
- - name: "Checkout Miles SDK Import Library project"
- uses: actions/checkout@v2
- if: ${{ matrix.audio == 'miles' }}
- with:
- repository: 'withmorten/re3mss'
- path: 're3mss'
- - uses: actions/setup-python@v2
- with:
- python-version: '3.x'
- - name: "Use XCode 11 as default (conan-center-index does not provide XCode 12 binaries at the moment)"
- if: startsWith(matrix.os, 'macos')
- run: |
- sudo xcode-select --switch /Applications/Xcode_11.7.app
- - name: "Setup conan"
- run: |
- python -m pip install conan
- conan config init
- conan config set log.print_run_commands=True
- conan remote add bincrafters https://api.bintray.com/conan/bincrafters/public-conan
- conan remote add madebr_ps2dev https://api.bintray.com/conan/madebr/ps2dev
- - name: "Add os=playstation2 + gcc.version=3.2 to .conan/settings.yml"
- shell: python
- run: |
- import os, yaml
- settings_path = os.path.expanduser("~/.conan/settings.yml")
- yml = yaml.safe_load(open(settings_path))
- yml["os"]["playstation2"] = None
- yml["compiler"]["gcc"]["version"].append("3.2")
- yml["compiler"]["gcc"]["version"].sort()
- yaml.safe_dump(yml, open(settings_path, "w"))
- - name: "Create host profile"
- shell: bash
- run: |
- if test "${{ matrix.platform }}" = "ps2"; then
- cp vendor/librw/conan/playstation2 host_profile
- else
- cp ~/.conan/profiles/default host_profile
- fi
- - name: "Export Playstation 2 CMake toolchain conan recipe"
- run: |
- conan export vendor/librw/cmake/ps2toolchain ps2dev-cmaketoolchain/master@
- - name: "Export librw conan recipe"
- run: |
- conan export vendor/librw librw/master@
- - name: "Export Miles SDK conan recipe"
- if: ${{ matrix.audio == 'miles' }}
- run: |
- conan export re3mss miles-sdk/master@
- - name: "Download/build dependencies (conan install)"
- run: |
- conan install ${{ github.workspace }} reVC/master@ -if build -o reVC:audio=${{ matrix.audio }} -o librw:platform=${{ matrix.platform }} -o librw:gl3_gfxlib=${{ matrix.gl3_gfxlib || 'glfw' }} --build missing -pr:h ./host_profile -pr:b default -s reVC:build_type=RelWithDebInfo -s librw:build_type=RelWithDebInfo
- env:
- CONAN_SYSREQUIRES_MODE: enabled
- - name: "Build reVC (conan build)"
- run: |
- conan build ${{ github.workspace }} -if build -bf build -pf package
- - name: "Package reVC (conan package)"
- run: |
- conan package ${{ github.workspace }} -if build -bf build -pf package
- - name: "Create binary package (cpack)"
- working-directory: ./build
- run: |
- cpack -C RelWithDebInfo
- - name: "Archive binary package (github artifacts)"
- uses: actions/upload-artifact@v2
- with:
- name: "${{ matrix.os }}-${{ matrix.platform }}"
- path: build/*.tar.xz
- if-no-files-found: error
diff --git a/.github/workflows/reVC_msvc_amd64.yml b/.github/workflows/reVC_msvc_amd64.yml
deleted file mode 100644
index 71e0ff1d..00000000
--- a/.github/workflows/reVC_msvc_amd64.yml
+++ /dev/null
@@ -1,67 +0,0 @@
-name: reVC premake amd64
-
-on:
- pull_request:
- push:
- release:
- types: published
-env:
- GLEW_VER: "2.1.0"
- GLFW_VER: "3.3.2"
- GLEW_BASE: "glew-2.1.0"
- GLFW_BASE: "glfw-3.3.2.bin.WIN64"
- GLEW_FILE: "glew-2.1.0-win32.zip"
- GLFW_FILE: "glfw-3.3.2.bin.WIN64.zip"
- GLEW_URL: "https://github.com/nigels-com/glew/releases/download/glew-2.1.0/glew-2.1.0-win32.zip"
- GLFW_URL: "https://github.com/glfw/glfw/releases/download/3.3.2/glfw-3.3.2.bin.WIN64.zip"
-jobs:
- build:
- runs-on: windows-2019
- strategy:
- matrix:
- platform: [win-amd64-librw_d3d9-oal, win-amd64-librw_gl3_glfw-oal]
- buildtype: [Debug, Release, Vanilla]
- steps:
- - name: Add msbuild to PATH
- uses: microsoft/setup-msbuild@v1.0.2
- - uses: actions/checkout@v2
- with:
- submodules: 'true'
- - if: ${{ matrix.platform }} == "win-amd64-librw_gl3_glfw-mss"
- name: Download glew
- uses: carlosperate/download-file-action@v1.0.3
- with:
- file-url: ${{env.GLEW_URL}}
- - if: ${{ matrix.platform }} == "win-amd64-librw_gl3_glfw-mss"
- name: Download glfw
- uses: carlosperate/download-file-action@v1.0.3
- with:
- file-url: ${{env.GLFW_URL}}
- - if: ${{ matrix.platform }} == "win-amd64-librw_gl3_glfw-mss"
- name: Unpack archives
- run: |
- 7z x ${{env.GLEW_FILE}}
- 7z x ${{env.GLFW_FILE}}
- - name: Configure build
- run: |
- ./premake5 vs2019 --with-librw --glewdir=${{env.GLEW_BASE}} --glfwdir64=${{env.GLFW_BASE}}
- - name: Build
- run: |
- msbuild -m build/reVC.sln /property:Configuration=${{matrix.buildtype}} /property:Platform=${{matrix.platform}}
- - name: Pack artifacts
- run: |
- 7z a reVC_${{matrix.buildtype}}_${{matrix.platform}}.zip ./bin/${{matrix.platform}}/${{matrix.buildtype}}/*
- - name: Upload artifact to actions
- uses: actions/upload-artifact@v2
- with:
- name: reVC_${{matrix.buildtype}}_${{matrix.platform}}
- path: ./bin/${{matrix.platform}}/${{matrix.buildtype}}
-# - name: Upload artifact to Bintray
-# uses: hpcsc/upload-bintray-docker-action@v1
-# with:
-# repository: reVC
-# package: ${{matrix.buildtype}}_${{matrix.platform}}
-# version: 1.0-$(echo ${GITHUB_SHA}
-# sourcePath: ./bin/${{matrix.platform}}/${{matrix.buildtype}}
-# username: gtamodding
-# apiKey: ${{secrets.BINTRAY_API_KEY}}
diff --git a/.github/workflows/reVC_msvc_x86.yml b/.github/workflows/reVC_msvc_x86.yml
deleted file mode 100644
index f7484ec2..00000000
--- a/.github/workflows/reVC_msvc_x86.yml
+++ /dev/null
@@ -1,68 +0,0 @@
-name: reVC premake x86
-
-on:
- pull_request:
- push:
- release:
- types: published
-env:
- GLEW_VER: "2.1.0"
- GLFW_VER: "3.3.2"
- GLEW_BASE: "glew-2.1.0"
- GLFW_BASE: "glfw-3.3.2.bin.WIN32"
- GLEW_FILE: "glew-2.1.0-win32.zip"
- GLFW_FILE: "glfw-3.3.2.bin.WIN32.zip"
- GLEW_URL: "https://github.com/nigels-com/glew/releases/download/glew-2.1.0/glew-2.1.0-win32.zip"
- GLFW_URL: "https://github.com/glfw/glfw/releases/download/3.3.2/glfw-3.3.2.bin.WIN32.zip"
-jobs:
- build:
- runs-on: windows-2019
- strategy:
- matrix:
- platform: [win-x86-librw_d3d9-mss, win-x86-librw_gl3_glfw-mss, win-x86-librw_d3d9-oal, win-x86-librw_gl3_glfw-oal]
- buildtype: [Debug, Release, Vanilla]
- steps:
- - name: Add msbuild to PATH
- uses: microsoft/setup-msbuild@v1.0.2
- - uses: actions/checkout@v2
- with:
- submodules: 'true'
- - if: ${{ matrix.platform }} == "win-x86-librw_gl3_glfw-mss"
- name: Download glew
- uses: carlosperate/download-file-action@v1.0.3
- with:
- file-url: ${{env.GLEW_URL}}
- - if: ${{ matrix.platform }} == "win-x86-librw_gl3_glfw-mss"
- name: Download glfw
- uses: carlosperate/download-file-action@v1.0.3
- with:
- file-url: ${{env.GLFW_URL}}
- - if: ${{ matrix.platform }} == "win-x86-librw_gl3_glfw-mss"
- name: Unpack archives
- run: |
- 7z x ${{env.GLEW_FILE}}
- 7z x ${{env.GLFW_FILE}}
- - name: Configure build
- run: |
- ./premake5 vs2019 --with-librw --glewdir=${{env.GLEW_BASE}} --glfwdir32=${{env.GLFW_BASE}}
- - name: Build
- run: |
- msbuild -m build/reVC.sln /property:Configuration=${{matrix.buildtype}} /property:Platform=${{matrix.platform}}
- - name: Pack artifacts
- run: |
- 7z a reVC_${{matrix.buildtype}}_${{matrix.platform}}.zip ./bin/${{matrix.platform}}/${{matrix.buildtype}}/*
- - name: Upload artifact to actions
- uses: actions/upload-artifact@v2
- with:
- name: reVC_${{matrix.buildtype}}_${{matrix.platform}}
- path: reVC_${{matrix.buildtype}}_${{matrix.platform}}.zip
-# - name: Upload artifact to Bintray
-# uses: hpcsc/upload-bintray-docker-action@v1
-# with:
-# repository: reVC
-# package: ${{matrix.buildtype}}_${{matrix.platform}}
-# version: 1.0-$(echo ${GITHUB_SHA}
-# sourcePath: ./bin/${{matrix.platform}}/${{matrix.buildtype}}
-# username: gtamodding
-# apiKey: ${{secrets.BINTRAY_API_KEY}}
-
diff --git a/.gitignore b/.gitignore
index ae091efd..896276a4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -359,6 +359,8 @@ codewarrior/reVC_Data/
codewarrior/Release/
codewarrior/Debug/
+src/extras/GitSHA1.cpp
+
*.rpx
*.elf
/.vscode
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 7282135d..e8689b38 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -6,6 +6,10 @@ set(PROJECT REVC)
project(${EXECUTABLE} C CXX)
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
+include(GetGitRevisionDescription)
+get_git_head_revision(GIT_REFSPEC GIT_SHA1 "ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR")
+message(STATUS "Building ${CMAKE_PROJECT_NAME} GIT SHA1: ${GIT_SHA1}")
+
if(WIN32)
set(${PROJECT}_AUDIOS "OAL" "MSS")
else()
diff --git a/README.md b/README.md
index 913ca390..c603466f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# reVC-wiiu
-
+
This is a port of GTA Vice City to the Nintendo Wii U.
@@ -12,49 +12,192 @@ Then clone this repo using `git clone --recursive https://github.com/GaryOderNic
To build the channel edit `CHANNEL_BUILD := 0` to `CHANNEL_BUILD := 1` in the `Makefile`.
# Original README
+
[](https://actions-badge.atrox.dev/GTAmodding/re3/goto?ref=miami)
-
+
## Intro
-The aim of this project is to reverse GTA Vice City for PC.
+In this repository you'll find the fully reversed source code for GTA III ([master](https://github.com/GTAmodding/re3/tree/master/) branch) and GTA VC ([miami](https://github.com/GTAmodding/re3/tree/miami/) branch).
+
+It has been tested and works on Windows, Linux and FreeBSD, on x86, amd64, arm and arm64.\
+Rendering is handled either by original RenderWare (D3D8)
+or the reimplementation [librw](https://github.com/aap/librw) (D3D9, OpenGL 2.1 or above, OpenGL ES 2.0 or above).\
+Audio is done with MSS (using dlls from original GTA) or OpenAL.
+
+We cannot build for PS2 or Xbox yet. If you're interested in doing so, get in touch with us.
## How can I try 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.
+- Build reVC or download the latest nightly build:
+ - [Windows D3D9 MSS 32bit](https://nightly.link/GTAmodding/re3/workflows/reVC_msvc_x86/miami/reVC_Release_win-x86-librw_d3d9-mss.zip)
+ - [Windows D3D9 64bit](https://nightly.link/GTAmodding/re3/workflows/reVC_msvc_amd64/miami/reVC_Release_win-amd64-librw_d3d9-oal.zip)
+ - [Windows OpenGL 64bit](https://nightly.link/GTAmodding/re3/workflows/reVC_msvc_amd64/miami/reVC_Release_win-amd64-librw_gl3_glfw-oal.zip)
+ - [Linux 64bit](https://nightly.link/GTAmodding/re3/workflows/build-cmake-conan/miami/ubuntu-latest-gl3.zip)
+ - [MacOS 64bit](https://nightly.link/GTAmodding/re3/workflows/build-cmake-conan/miami/macos-latest-gl3.zip)
+- Extract the downloaded zip over your GTA VC directory and run reVC. The zip includes the gamefiles and in case of OpenAL the required dlls.
-## Preparing the environment for building
+## Screenshots
-You may want to point GTA_VC_RE_DIR environment variable to GTA VC 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
+## Improvements
+
+We have implemented a number of changes and improvements to the original game.
+They can be configured in `core/config.h`.
+Some of them can be toggled at runtime, some cannot.
+
+* Fixed a lot of smaller and bigger bugs
+* User files (saves and settings) stored in GTA root directory
+* Settings stored in reVC.ini file instead of gta_vc.set
+* Debug menu to do and change various things (Ctrl-M to open)
+* Debug camera (Ctrl-B to toggle)
+* Rotatable camera
+* XInput controller support (Windows)
+* No loading screens between islands ("map memory usage" in menu)
+* Rendering
+ * Widescreen support (properly scaled HUD, Menu and FOV)
+ * PS2 MatFX (vehicle reflections)
+ * PS2 alpha test (better rendering of transparency)
+ * Xbox vehicle rendering
+ * Xbox world lightmap rendering (needs Xbox map)
+ * Xbox ped rim light
+ * Xbox screen rain droplets
+ * More customizable colourfilter
+* Menu
+ * More options
+ * Controller configuration menu
+ * ...
+* Can load DFFs and TXDs from other platforms, possibly with a performance penalty
+* ...
+
+## To-Do
+
+The following things would be nice to have/do:
+
+* Fix physics for high FPS
+* Improve performance on lower end devices, especially the OpenGL layer on the Raspberry Pi (if you have experience with this, please get in touch)
+* [PS2 port](https://github.com/GTAmodding/re3/wiki/PS2-port)
+* Xbox port (not quite as important)
+* reverse remaining unused/debug functions
+* compare CodeWarrior build with original binary for more accurate code (very tedious)
+
+## Modding
+
+Asset modifications (models, texture, handling, script, ...) should work the same way as with original GTA for the most part.
+
+Mods that make changes to the code (dll/asi, CLEO, limit adjusters) will *not* work.
+Some things these mods do are already implemented in re3 (much of SkyGFX, GInput, SilentPatch, Widescreen fix),
+others can easily be achieved (increasing limis, see `config.h`),
+others will simply have to be rewritten and integrated into the code directly.
+Sorry for the inconvenience.
+
+## Building from Source
+
+When using premake, you may want to point GTA_VC_RE_DIR environment variable to GTA Vice City root folder if you want the executable to be moved there via post-build script.
+
+Clone the repository with `git clone --recursive -b miami https://github.com/GTAmodding/re3.git reVC`. Then `cd reVC` into the cloned repository.
+
+Linux Premake
+
+For Linux using premake, proceed: [Building on Linux](https://github.com/GTAmodding/re3/wiki/Building-on-Linux)
+
+Linux Conan
+
+Install python and conan, and then run build.
+```
+conan export vendor/librw librw/master@
+mkdir build
+cd build
+conan install .. reVC/master@ -if build -o reVC:audio=openal -o librw:platform=gl3 -o librw:gl3_gfxlib=glfw --build missing -s reVC:build_type=RelWithDebInfo -s librw:build_type=RelWithDebInfo
+conan build .. -if build -bf build -pf package
+```
+FreeBSD
+
+For FreeBSD using premake, proceed: [Building on FreeBSD](https://github.com/GTAmodding/re3/wiki/Building-on-FreeBSD)
+
+Windows
+
+Assuming you have Visual Studio 2015/2017/2019:
+- Run one of the `premake-vsXXXX.cmd` variants on root folder.
+- Open build/reVC.sln with Visual Studio and compile the solution.
-**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)
+Microsoft recently discontinued its downloads of the DX9 SDK. You can download an archived version here: https://archive.org/details/dxsdk_jun10
-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.
+**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).
+