Game engine, capable of running KotOR and TSL

Find a file

Vsevolod Kremianskii b750adcb64 fix: Fix water rendering		2021-01-27 17:44:35 +07:00
cmake	chore: Update year in copyright notices	2021-01-02 22:06:11 +07:00
doc	feat: Implement stunt models in conversations	2021-01-06 18:28:39 +07:00
external	feat: Implement TPC to TGA conversion in reone-tools	2021-01-13 20:30:48 +07:00
res	feat: Add bare in-game options and save/load menus	2020-11-07 12:43:30 +07:00
src	fix: Fix water rendering	2021-01-27 17:44:35 +07:00
tests	style: Use make_shared/make_unique functions universally	2021-01-20 14:11:32 +07:00
tools	fix: Fix segfault when converting TPC to TGA	2021-01-26 21:25:01 +07:00
.editorconfig	style: Add .editorconfig file for C++	2020-12-22 17:58:47 +07:00
.gitignore	Initial commit	2020-08-02 22:47:59 +07:00
.travis.yml	chore: Update year in copyright notices	2021-01-02 22:06:11 +07:00
CMakeLists.txt	feat: Implement onClick and onEnter GUI sounds	2021-01-20 16:32:46 +07:00
CONTRIBUTORS	doc: Update CONTRIBUTORS	2020-11-18 23:12:16 +07:00
COPYING	Change license to GNU GPL 3	2020-08-03 08:06:55 +07:00
README.md	doc: Mention pressing space to pause the game	2021-01-20 02:02:47 +07:00

README.md

reone

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

The project is in the early stages of development at this point: resource management, scene management, rendering, audio, GUI and scripting subsystems are already implemented, while game mechanics are actively being worked on. See project gallery and roadmap in the Wiki.

Contributing

reone is open to potential contributors. Contact me at vkremianskii@gmail.com or on Discord if you're interested in taking a particular task from the roadmap.

Developer resources:

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.

reone must only be used to run a legal copy of the game - both KotOR and TSL can be obtained from Steam or GOG.com. Keep in mind that mod compatibility is not being tested and thus cannot be 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 and ZC keys to move around
Left click to interact with an object
Press Space to pause the game
Press V to switch the camera type
Use "-" and "+" keys to adjust the game speed
Press "~" to toggle the debug console

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 a complete list of options here.

Similar Projects

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

xoreos - a reimplementation of BioWare's Aurora engine and its derivatives.
KotOR.js - a remake of the Odyssey engine written in JavaScript.
The Northern Lights - a Unity-based reimplementation and a level editor.
KotOR-Unity - another Unity-based reimplementation.

In contrast, this is what reone offers:

KotOR and TSL only, unlike xoreos, which aims to reimplement all of Aurora engine games - codebase is lighter and development is more focused.
Written in C++ - industry standard language, faster than the JavaScript implementation.
Custom game engine based on SDL 2 and OpenGL 3.3 - does not depend on Unity, which is a proprietary software with a learning curve of itself.