Corona Game Engine main repository
Clone or download

README.md

Corona (CoronaSDK)

Simple to learn and use 2D game engine developed by Corona Labs

Corona Logo

Easy-to-learn & powerful

Corona is a cross-platform framework ideal for rapidly creating apps and games for mobile devices, TV, desktop systems and HTML5. That means you can create your project once and publish it to multiple types of devices, including Apple iPhone and iPad, Android phones and tablets, Amazon Fire, Mac Desktop, Windows Desktop, Linux, HTML5 and even connected TVs such as Apple TV, Fire TV, and Android TV.

Benefits of usage Corona

  • Free for everybody – Enterprise features for every developer.
  • The easiest development tool for 2D games and mobile applications.
  • Corona allows creating apps easily, up to 10 times faster than other frameworks.
  • Corona is supported by detailed documentation system.
  • Write the code once, run it many different places – Corona supports all major mobile platforms.
  • Corona Marketplace is a constantly growing store with more than 150 plugins and 300+ ready-to-go app assets.
  • Corona community unites more than 200,000 passionate developers.
  • Corona Simulator, which runs the app directly on PC/Mac, simplifies the prototyping process and helps quickly test ideas and concepts.
  • Corona has a logical and consistent API that covers over 1000 functions and allows to get things up and running very fast.

Feature highlights

Corona Simulator and Live Builds

Corona speeds up the development process. Update your code, save the changes, and instantly see the results in our instant-update Simulator. When you're ready to test on real devices, build and deploy your app just once and then see code/assets update automatically, all over your local network. It's like magic.

Lua-based

Lua is an open source scripting language designed to be lightweight, fast, yet also powerful. Lua is currently the leading scripting language in games and has been utilized in Warcraft ™, Angry Birds ™, Civilization ™, and many other popular franchises.

Plugins for all needs

Select from numerous plugins which extend the Corona core for features like in-app advertising, analytics, media, and much more. A vast variety of plugins is available via Corona Marketplace.

Call any native library

If it’s not already in the core or supported via a plugin, you can call any native (C/C++/Obj-C/Java) library or API using Corona Native. It also allows to easily package your code as a plugin.

Cross-platform

Develop for mobile, desktop, and connected TV devices with just one code base.

Installation

The easiest and recommended way to get started with Corona is to download binary distribution from Corona Labs website.

API documentation and guides

Exhaustive Corona API documentation, as well as getting started and more advanced guides are available on docs.coronalabs.com.

Source Code and licensing

Corona is dual-licensed under both a commercial and open source license.

The commercial Corona license gives you the full rights to customize the engine and distribute built apps on your own terms without any open source license obligations. Binary distributions obtained from coronalabs.com are using this license.

Corona is also available under the GPLv3 open source license. Corona open source licensing is ideal for use cases such as open source projects, research or educational purposes. See LICENSE.GPL for full text of GPL license.

Note that Corona incorporates many libraries, both third-party and made by Corona Labs. They may have different licenses.

Contributing

If you are willing to improve Corona by contributing code, fork this repository and create a pull request with desired improvements. The project uses git submodules, so to clone the whole source code tree run

git clone --recursive https://github.com/coronalabs/corona.git

Due to the dual-licensed nature of Corona distribution, all contributors would have to sign a simple Contributor License Agreement (CLA) to ensure that their code can be part of Corona ecosystem. For more details see CONTRIBUTING.md.

Entry points for each platform are located in the platform directory. Refer to README.md files in its subdirectories.

Governance and Code of Conduct

Corona is maintained by Corona Labs organization. Our mission is to make Corona the best game engine ever.

To participate in the Corona community or development you must follow the Corona Community Code of Conduct (see CODE_OF_CONDUCT.md)