Giter Club home page Giter Club logo

reone's Introduction

reone

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 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 roadmap for our long-term plans.

Legal

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 provided 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.

Installation

To install reone, 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 is being developed and tested against unmodded Steam versions of both KotOR and TSL. Compatibility with any other version is not guaranteed, although GOG and retail versions should work with no or minor modification.

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

Usage

Use launcher application to choose a game directory and launch reone. Alternatively, reone can be started from the command line: reone --game GAME_DIR

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.

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:

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

reone's People

Contributors

azurda avatar brianallred avatar lacc97 avatar projectsynchro avatar seedhartha avatar uwadmin12 avatar wbrawner avatar ziemas avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.