diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 534e010a..89a3f65f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,72 +1,3 @@ -# Contributing -Pull requests which drastically alter the structure or architecture of the code will not be accepted. -This is to maintain "sanity" whilst going back through code, comparing to the original MIPS disassembled output. -Best pull requests are which resolve bugs, finish existing decompiled methods, improve readability, introduce new decompiled methods and improve code documentation. +# Moved -It's also good to see which issues have more priority to work with here: -https://github.com/OpenDriver2/REDRIVER2/contribute - -#### Markers for decompiled function names, code, etc - -- [D] = decompiled -- [T] = debugged and tested -- [A] = altered code - debugging purposes or not being able to compile or run.... Can be used anywhere in the code, structures etc - -# Base Versions -- **SLES-02996/SLES-12996** - 1.0 Italian version (look for `ITALIAN.SYM` existence) -- **SLES-02997/SLES-12997** - 1.0 Spanish version (look for `SPANISH.SYM` existence) - -# Game Content -See [Wiki/Installation Instructions](https://github.com/OpenDriver2/REDRIVER2/wiki/Installation-instructions) - -# Prerequisites -You'll need to acquire a few dependencies in order to start developing for **REDRIVER2**. - -The default location for dependencies are in the `src_rebuild\dependencies` folder: -``` -SDL2_DIR = \SDL2 -OPENAL_DIR = \openal-soft -JPEG_DIR = \jpeg -``` - -Alternatively, you can set environment variables like so: -``` -SDL2_DIR = \SDL2-2.0.12 -OPENAL_DIR = \openal-soft-1.20.1-bin -JPEG_DIR = \jpeg-9d -``` - -Once you've got your folder(s) setup, you'll need to download the following dependencies. - -## SDL 2 -- [Download](https://www.libsdl.org/release/SDL2-devel-2.0.12-VC.zip) - -Place all files in your `SDL2_DIR` directory. - -## OpenAL-Soft -- [Download](https://openal-soft.org/openal-binaries/openal-soft-1.20.1-bin.zip) - -Place all files in your `OPENAL_DIR` directory. - -## JPEG -- [Download](http://www.ijg.org/files/jpegsr9d.zip) - -Place all files in your `JPEG_DIR` directory. - -You'll also need to rename `jconfig.xx` (proper one for your platform) to `jconfig.h`. -For *Windows / Visual Studio* this means renaming `jconfig.vc` to `jconfig.h`. - -## Premake 5 -- [Download](https://github.com/premake/premake-core/releases/download/v5.0.0-alpha15/premake-5.0.0-alpha15-windows.zip) - -Place `premake5.exe` in your `src_rebuild` folder in order to generate project files. - -Make sure you have downloaded all other dependencies first before running premake. - -Next you need to run `premake5 `, see premake documentation; -Or just run `gen_vc2019.bat` (Windows only) - -# Compiling -Project **must** be targeted for **32-bit** platforms only. This is due to the size of pointers and other types (such as *long* in GCC) being different on 64-bit platforms. - -You can also download pre-compiled [nightly builds](https://ci.appveyor.com/project/SoapyMan/redriver2-10jm8/branch/master) or the latest [release builds](https://github.com/OpenDriver2/REDRIVER2/releases) as well. +See [Contributing to project](https://github.com/OpenDriver2/REDRIVER2/wiki/Contributing-to-project) page for details \ No newline at end of file diff --git a/README.md b/README.md index c4fed226..a194c77f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -# REDRIVER2 +# REDRIVER2 (Reverse-Engineered Driver 2) PC (Windows and Linux): [![Build status](https://ci.appveyor.com/api/projects/status/9abepvls6jexapqy/branch/master?svg=true)](https://ci.appveyor.com/project/SoapyMan/redriver2-10jm8/branch/master) +![REDRIVER2 running on Windows](https://i.ibb.co/2q1pp06/red2.png) + ### Timeline: - Feb 19, 2019 - created skeleton, one year long preparations - Mar 28, 2020 - started work on reimplementing the game, game intro running @@ -27,10 +29,13 @@ PC (Windows and Linux): ### How to use See [Wiki/Installation Instructions](https://github.com/OpenDriver2/REDRIVER2/wiki/Installation-instructions) +### How I can contribute? +See [Contributing to project](https://github.com/OpenDriver2/REDRIVER2/wiki/Contributing-to-project) page + ### Credits -- Soapy - lead programmer -- Fireboyd78 - code refactoring and improvements -- Krishty, someone972 - formats decoding -- Gh0stBlade - API-level PSY-Q libraries reimplementation (HLE PSX Emulator) [(link)](https://github.com/tomb5/tomb5) -- Ben Lincoln - [This Dust Remembers What It Once Was](https://www.beneaththewaves.net/Software/This_Dust_Remembers_What_It_Once_Was.html) (*TDR*) -- Stohrendorf - [Symdump](https://github.com/stohrendorf/symdump) utility \ No newline at end of file +- **SoapyMan** - lead reverse engineer and programmer +- **Fireboyd78** - code refactoring and improvements +- **Krishty, someone972** - early formats decoding +- **Gh0stBlade** - HLE Emulator code used as a base for Psy-Cross [(link)](https://github.com/TOMB5/TOMB5/tree/master/EMULATOR) +- **Ben Lincoln** - [This Dust Remembers What It Once Was](https://www.beneaththewaves.net/Software/This_Dust_Remembers_What_It_Once_Was.html) (*TDR*) +- **Stohrendorf** - [Symdump](https://github.com/stohrendorf/symdump) utility \ No newline at end of file diff --git a/src_rebuild/PsyX/README.md b/src_rebuild/PsyX/README.md index 30ef9378..5ca7b176 100644 --- a/src_rebuild/PsyX/README.md +++ b/src_rebuild/PsyX/README.md @@ -10,6 +10,7 @@ Framework aiming to build and run originally targeted **Playstation** applicatio - **PGXP-Z** - PGXP support with optimized vertex cache lookup and extended with *modern 3D hardware perspective transform* and *Z-buffer* support **PGXP-Z** - *LibSPU* with ADPCM decoding on OpenAL (SPU-AL) - *LibGPU* with Playstation-style polygon and image handling +- Already proven to be *95% compatible* with the Psy-Q Playstation SDK - Psy-X game look identical to the Playstation game ## TODO - Add some missing LibGTE functions