devkevyt/pixxel

LibGDX engine for 2d games.

This branch only contains the source code as well as the gradle script files and assets with some readme's
to help you getting an overview before starting.
To start a project using the existing code refer to the release tags on the right.

Pixxel

LibGDX engine for 2d games.
This engine provides some basic game handling features to get you startet on your project.
Please note that this is not a full AAA type of Engine like Unity to create games within minutes.
This engine is supposed to help you getting started for your indie game project using LibGDX.

Features

This engine features

• World rendering
• Real time level editor
• Built in script to bring your worlds to life
• Asset handling
• Box2d and Box2d lights physics
• Basic pathfinding AI

Getting started

To get started with your project, please refer to my video tutorial [here](coming soon)

• Download the latest release
• Open the folder in Android Studio
• Sync the project

With this method, you still have full control over the whole code.
It is your project, right?

This project requires the following versions:

• Java source and target compatibillity: 1.8 (build.gradle)
• gdxVersion 1.9.9 (build.gradle)

The following paragraphs give a brief explanation on the structure. For more information, please look at the Pixxel Wiki

File structure and how to get along

Every file that is needed for your game is located in */android/assets/

Game File

The game.json file is the most important file of your, well, game.
It holds information where your assets and objects are located in your file system. It also manages some saved data of your player like inventory etc.

Take a look here for more information about the game file.

World Files

Most likely your game won't just consist of one single world, right?
You can create world files wherever you like (The game.json file will keet track of your worlds),
but using the default path /assets/local/worlds/ is a good choice.

Object Files

Every object in your world consists of a simple json file. Again, you can store your objects wherever you like, but remember to put the relative path in your game.json file.

Another program to create and edit objects without creating a file manually is in progress but not finished.
So you need to create objects manually.
Explanations and examples can be found here

Script syntax and usage

As mentioned above, this engine also features a script.
This script is very useful for some basic level behaviors like

• Opening doors ...
• Lighting torches ...
• Entering houses ...
• Teleporting the player ...
• Etc ...

A list of default commands can be found here If the default commands are not enough, you can create and add your own.
You can watch a tutorial on how to use this script [here](coming soon ...)
or read the syntax and download a test program here