Table of Contents

Getting Started with Orx

This wiki contains tutorials, tips and general information about Orx, a portable, open source and data-driven 2D-oriented game engine.

You are encouraged to contribute to this wiki by adding code samples, tips or any useful information that could help other people with this engine.

Getting Orx and Initial Setup

The latest up to date version of Orx can be cloned from github and set up with:

git clone https://github.com/orx/orx.git 

This is the recommended version of Orx to use.

You'll then need to go through a one-time only, simple setup. For details on this procedure, please see: Cloning Orx from Github and Initial Setup

Setting up a Development Environment

If you don't have a compiler and editor yet, these guides can help you get started with some choice suitable for Orx. Windows does not need any particular set up.

Choosing a compiler and building Orx

Starting your own Orx based Project

Learning to program with Orx

Beginner's Guide

Our main guide for teaching newcomers how to set up Orx, create a project and write a simple game.

Config system

The config section details what the config system is, what each of the sections and properties are, and how they are used to set up the configuration data in your Orx game or application.

Examples

The examples section provides quick code snippits or reminders of how to use a particular function.

Tutorials

The tutorials section gives you help on a number of topics: animation, game development, compiling Orx, setting up projects, tips and techniques.