/KlayGE

KlayGE is a cross-platform open source game engine with plugin-based architecture.

Primary LanguageC++GNU General Public License v2.0GPL-2.0

KlayGE

GitHub release Build Status

KlayGE is a cross-platform open source game engine with plugin-based architecture. It's started since 2003. The explicit goal of KlayGE is: to arm your engine with cutting-edge technology. It provides a framework to make game development, testing, porting as simple as possible.

Getting started

Before compiling KlayGE, Python 3.x+ and CMake 3.13+ must be installed first. Then you can run Build.py to build the whole code base. For details, please see Installation.

Platforms

KlayGE can be developed on those platforms, with no limitation.

  • Windows desktop
  • macOS
  • Linux

KlayGE can be deployed and run on those runtime platforms. Some of them doesn't supports all plugins. Details in Platforms

  • Windows desktop
  • Windows store
  • Android
  • Linux
  • macOS
  • iOS

Contribute

As an open source project, KlayGE benefits greatly from both the volunteer work of helpful developers and good bug reports made by users.

Bug Reports & Feature Requests

If you've noticed a bug or have an idea that you'd like to see come real, why not work on it? Bug reports and feature requests are typically submitted to the issue tracker.

Engineering Workflow

If you want contribute some code, please check Workflow of Contributing Code before submitting a patch or pull request.

Links

License

KlayGE's default license is the GNU General Public License 2.0 (See LICENSE). In other words, anyone can use it and access to its source code, as long as the project which uses KlayGE must be released under GPL 2.0 license.

KlayGE dependents on several external libraries. They are distributed under their own terms. See LICENSE-External.