wbrawner/reone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
reone/README.md
Vsevolod Kremianskii 2af40d5573 ci: Integrate Coverity Scan into Travis CI pipeline
2020-09-24 22:59:11 +07:00

3.1 KiB
Raw Blame History

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
  • Do all sorts of experiments using original games assets
  • Create total conversion mods

Currently, the most fundamental engine subsystems are already implemented. Actual gameplay, however, is very limited. See project gallery and roadmap 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 established and a much more ambitious project, which I had contributed to and use alot as a reference. However, it is not very active anymore and I find it to be too complex and unoptimized for my taste.
  • KotOR.js – a JavaScript-based remake.
  • KotOR-Unity – a Unity-based reimplementation.
  • The Northern Lights by Lachlan O'Neill – another Unity-based reimplementation and a level editor.

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 in the early stages of development at the moment, meaning that the codebase is not entirely stable. Nevertheless, the project is open to potential contributors. Take a look at the roadmap and development pages in the Wiki if you want to contribute.