Game engine, capable of running KotOR and TSL
Find a file
2020-12-18 18:48:35 +07:00
cmake chore: Switch to a centralized copyright notice 2020-11-18 13:06:55 +07:00
doc doc: Update diagrams 2020-12-09 18:14:19 +07:00
external/glm Initial commit 2020-08-02 22:47:59 +07:00
res feat: Add bare in-game options and save/load menus 2020-11-07 12:43:30 +07:00
src refactor: Rename CameraObject to PlaceableCamera to match nwscript.nss 2020-12-18 18:48:35 +07:00
tests refactor: Refactor combat 2020-11-21 19:13:05 +07:00
tools feat: Output row index when converting 2DA to JSON 2020-12-10 12:44:47 +07:00
.gitignore Initial commit 2020-08-02 22:47:59 +07:00
.travis.yml chore: Switch to a centralized copyright notice 2020-11-18 13:06:55 +07:00
CMakeLists.txt refactor: Rename CameraObject to PlaceableCamera to match nwscript.nss 2020-12-18 18:48:35 +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 feat: Implement clear and playanim console commands 2020-12-13 13:07:07 +07:00

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

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 if you're interested in taking a particular task from the roadmap. For an overview of the project architecture and other developer resources, visit the development page 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. 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 and ZC keys to move around
  • Left click to interact with an object
  • 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 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++ - industry standard, statically typed language; faster and more compatible than the JavaScript implementation.
  • 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.