Game engine, capable of running KotOR and TSL

Find a file

Vsevolod Kremianskii 9ee347f725 Rephrase Legal Stance in README [ci skip]		2021-06-13 07:54:19 +07:00
.github/workflows	ci: Remove Azure from APT sources	2021-03-23 09:47:45 +07:00
cmake	chore: Update year in copyright notices	2021-01-02 22:06:11 +07:00
images	Remove outdated models diagram	2021-05-15 11:17:35 +07:00
res	Simplify materials	2021-05-12 12:20:43 +07:00
scripts	Remove default options in extract script	2021-06-08 21:53:10 +07:00
src	Use forward declarations in game/camera	2021-06-12 19:08:10 +07:00
.gitignore	Add Python script to generate LIP files from text	2021-04-22 21:10:20 +07:00
CMakeLists.txt	Fix builds on macOS	2021-06-11 11:10:29 +07:00
CONTRIBUTORS	Update CONTRIBUTORS	2021-05-19 09:14:41 +07:00
COPYING	Change license to GNU GPL 3	2020-08-03 08:06:55 +07:00
README.md	Rephrase Legal Stance in README	2021-06-13 07:54:19 +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 at a mid-stage of development: most engine subsystems have already been implemented, while game mechanics are actively being worked on. See project gallery and roadmap in the Wiki.

Legal Stance

reone adheres to clean-room design principles. We do not condone the use of decompilation - instead, we rely on publicly available information (e.g., file format specification released by BioWare) and our own observations of the game and its resources.

We do not distribute copyrighted materials - instead, we require our users and developers to obtain a legal copy of the game.

Lastly, reone is explicitly a non-commercial project: we do not seek to gain profit, neither through donations nor other means.

Contributing

reone is open to potential contributors. Contact us on this Discord server 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

Launch reone using the launcher application or from the command line:

reone --game C:\swkotor

Configuration

reone can be configured via the launcher, the configuration file or the command line.

Configuration file, named "reone.cfg", must be located in the current directory. See complete list of program 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.