wbrawner/reone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Game engine, capable of running KotOR and TSL
307 commits 7 branches 17 tags 17 MiB
C++ 97.1%
Python 1.5%
CMake 1.4%
Find a file
Vsevolod Kremianskii 577c48293d refactor: Move Blueprints class to the blueprint folder
2020-10-28 08:32:16 +07:00
cmake Change license to GNU GPL 3 2020-08-03 08:06:55 +07:00
doc doc: Update the project architecture diagram 2020-10-26 09:43:17 +07:00
external/glm Initial commit 2020-08-02 22:47:59 +07:00
src refactor: Move Blueprints class to the blueprint folder 2020-10-28 08:32:16 +07:00
tests refactor: Split libsystem into multiple libraries 2020-10-26 09:21:21 +07:00
tools refactor: Split libsystem into multiple libraries 2020-10-26 09:21:21 +07:00
.gitignore Initial commit 2020-08-02 22:47:59 +07:00
.travis.yml test: Add first unit test 2020-10-10 15:25:36 +07:00
CMakeLists.txt refactor: Move Blueprints class to the blueprint folder 2020-10-28 08:32:16 +07:00
COPYING Change license to GNU GPL 3 2020-08-03 08:06:55 +07:00
README.md doc: Update Similar Projects section in the readme file 2020-10-15 12:47:54 +07:00

README.md

reone

Build Status Coverity Scan Build Status

reone is a free and open source game engine, capable of running Star Wars: Knights of the Old Republic and its sequel, The Sith Lords. We aim to provide an engine that is flexible and modern, and can be used to:

  • Play KotOR and TSL from beginning to end
  • Create mods that drastically change the gameplay or improve the visuals

Currently, the most fundamental engine subsystems are already implemented. Actual gameplay, however, is very limited. See project gallery and roadmap in the Wiki.

Installation

Those wishing to test reone, can either download a prebuilt executable from the releases page, or build it from source. Building it requires a modern C++ compiler and a set of free and open source libraries. See detailed instructions for your operating system here.

To run a game using reone, you must legally own it – we do not endorse piracy. Nowadays both games can be downloaded from Steam or GOG.com. Keep in mind that reone is tested against vanilla versions of the games – mod support is not guaranteed.

Install Visual C++ Redistributable to run prebuilt Windows executables.

Usage

Specify a game path to run the game, e.g. reone --game C:\swkotor

Controls:

  • Use WASD keys to move around
  • Click on doors to open them

Configuration

reone can be configured from either a command line or a configuration file. Configuration file, named "reone.cfg", must be located in the current directory. See complete list of options here.

Contribution

reone is open to potential contributors. Contact me at vkremianskii@gmail.com if you're interested in taking a particular task from the roadmap. For an overview of the project architecture, take a look at the development page in the Wiki.

Similar Projects

reone is not the only project aiming to reimplement the Odyssey engine – there are at least four alternatives:

  • xoreos – a more ambitious and a more established project, which I had contributed to and use alot as a reference.
  • KotOR.js – a fascinating JavaScript-based remake.
  • KotOR-Unity – a Unity-based reimplementation.
  • The Northern Lights by Lachlan O'Neill – another Unity-based reimplementation and a level editor.

In contrast, this is what reone offers:

  • Written in C++ – faster than JavaScript and potentially Unity (C#) implementations.
  • Custom game engine based on SDL 2 and OpenGL 3.3 – no Unity knowledge required.
  • KotOR and TSL only, unlike xoreos, which aims to reimplement all of Aurora Engine games – faster development.