2020-07-24 17:58:27 +02:00
# Contributing
2020-08-28 07:39:27 +02:00
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.
2020-07-24 17:58:27 +02:00
2020-10-16 11:00:35 +02:00
Also it's good to see which issues have more priority to work with here:
https://github.com/SoapyMan/REDRIVER2/contribute
2020-07-24 17:38:25 +02:00
# Compiling
2020-10-16 11:00:35 +02:00
Project **must** be built only for **32 bit** platform because there are 32 bit pointers everywhere (and use of *long* which with GCC can be a 64 bit numbers)
First use [premake5 ](https://github.com/premake/premake-core/releases/download/v5.0.0-alpha15/premake-5.0.0-alpha15-windows.zip ) to generate project files.
2020-07-24 17:38:25 +02:00
2020-10-16 11:00:35 +02:00
Dependencies (links for Windows):
- [SDL 2 ](https://www.libsdl.org/release/SDL2-devel-2.0.12-VC.zip )
2020-10-16 14:53:45 +02:00
- [OpenAL-Soft ](https://openal-soft.org/openal-binaries/openal-soft-1.20.1-bin.zip )
2020-10-19 17:06:46 +02:00
- [JPEG ](http://www.ijg.org/files/jpegsr9d.zip )
2020-08-28 07:39:27 +02:00
2020-10-19 17:06:46 +02:00
#### Before running premake ####
You need to download all the dependencies and extract them.
After set next environment variables like:
2020-08-28 07:39:27 +02:00
```
SDL2_DIR = < your_dependency_folder > \SDL2-2.0.12
OPENAL_DIR = < your_dependency_folder > \openal-soft-1.20.1-bin
2020-10-19 17:06:46 +02:00
JPEG_DIR = < your_dependency_folder > \jpeg-9d
2020-08-28 07:39:27 +02:00
```
2020-10-19 17:06:46 +02:00
*JPEG* itself needs to be configured - go to your *JPEG_DIR* folder and rename `jconfig.xx` (proper one for your platform) to `jconfig.h` .
For *Windows / Visual Studio* you need to choose `jconfig.vc`
Next you need to run `premake5 <target IDE>` , see premake documentation;
Or just run `gen_vc2019.bat` (Windows only)
2020-07-24 17:38:25 +02:00
#### Markers for decompiled function names, code, etc
- [D] = decompiled
- [T] = debugged and tested
2020-10-16 11:00:35 +02:00
- [A] = altered code - debugging purposes or not being able to compile or run.... Can be used anywhere in the code, structures etc
2020-07-24 17:38:25 +02:00
2020-08-28 07:39:27 +02:00
# Base Versions
- **SLES-02997/SLES-12997** - 1.0 Spanish version (look for SPANISH.SYM existance)
- **SLES-02996/SLES-12996** - 1.0 Italian version (look for ITALIAN.SYM existance)
2020-10-16 11:00:35 +02:00
# Game Content
2020-11-18 20:47:38 +01:00
See [Wiki/Installation Instructions ](https://github.com/OpenDriver2/REDRIVER2/wiki/Installation-instructions )
