Skip to content

AliveTeam/alive_reversing

Repository files navigation

R.E.L.I.V.E.

An Open-Source Engine Replacement for Oddworld: Abe's Oddysee and Oddworld: Abe's Exoddus.

R.E.L.I.V.E. is a fan-made, open-source project that intends to become a fully compatible engine replacement for Oddworld Inhabitants' iconic first two games. The project's goals include fixing the original games' bugs and also eventually providing a modding / level creation interface, alongside of course making it possible to study or use the engine for new projects.

For more details, please check the project's website: https://aliveteam.github.io/

Function Keys

Key Name
F5 Quiksave (Exoddus only)
F6 Quikload (Exoddus only)
F10 Screen Filter
F11 Keep Aspect Ratio
F12 Fullscreen

Contributing

Anyone who wishes to contribute is encouraged to join the project's Discord, where most of the communication happens.

By contributing to this project, the contributor agrees and accepts that their code will be licensed under a GPL-compatible license (most likely the MIT/Expat license) in the future.

Building R.E.L.I.V.E.

Cloning

Since the project uses third-party repositories for some of its functions, you need to clone the project using the --recursive flag.

git clone --recursive https://github.com/AliveTeam/alive_reversing.git

Regardless of your platform, you need to create a folder called build in your repository root! .gitignore is configured to ignore this folder. This helps to prevent polluting the commits with binaries.

Build on Windows using Visual Studio 2022

Prerequisites

  1. CMake
  2. SDL2

Building

  1. Cd into the build directory:
cd build
  1. Generate the solution file:
cmake -S .. -B . -DSDL2_DIR=YOUR_SDL2_PATH

For example, if you installed SDL2 at C:\SDL2 you would run:

cmake -S .. -B . -DSDL2_DIR=C:\SDL2
  1. After cmake is done, open the generated relive.sln file within your build folder with Visual Studio 2022.
  2. To start the build, click on Build -> Build Solution and wait for the build to finish.
  3. Once the build has finished successfully, you'll find the relive executable in build/Source/relive/Debug and SDL2.dll in build/Source/AliveDllAE/Debug.
Build on Linux

Prerequisites

  1. CMake
  2. SDL2

Ubuntu

sudo apt install cmake libsdl2-dev
  1. Cd into the build directory:
cd build
  1. Generate the makefile:
cmake -S .. -B .
  1. Build relive:
make -j$(nproc)
  1. Once the build has finished successfully, you'll find the relive executable in build/Source/relive/Debug.
  2. You can optionally install the package using make install or create a Debian-compatible package using cpack -G DEB.

About

Re-implementation of Oddworld: Abe's Exoddus and Oddworld: Abe's Oddysee

Topics

Resources

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 21