Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 5.06 KB

README.md

File metadata and controls

100 lines (75 loc) · 5.06 KB
Raw

LITIENGINE Logo

LITIENGINE is a free and open source Java 2D Game Engine. It provides a comprehensive Java library and a dedicated map editor to create tile-based 2D games.

Build Status Coverage Maven Central MIT License Discord chat

Main Features

  • Basic Game Infrastructure (GameLoop, Configuration, Resource Management, Logging, ...)
  • 2D Render Engine (GUI Components, Spritesheet Animations, Ambient Lighting, Particle System, ...)
  • 2D Sound Engine (support for .wav, .mp3 and .ogg)
  • 2D Physics Engine
  • Support for Tile Maps in .tmx format (e.g. made with Tiled Editor)
  • Player Input via Gamepad/Keyboard/Mouse
  • Entity Framework

Installation

The library is distributed over the Maven Central Repository and you can grab the necessary .jar-file(s) from there by using your favorite build automation tool or manually download the library.

Gradle

repositories {
  mavenCentral()
}

dependencies {
  implementation 'de.gurkenlabs:litiengine:0.5.1'
}

Maven

<dependency>
  <groupId>de.gurkenlabs</groupId>
  <artifactId>litiengine</artifactId>
  <version>0.5.1</version>
</dependency>

More Installation Instructions

Getting Started

  1. Setup the Game Project
  2. Running the Game
  3. Configuring the Game
  4. Loading a .tmx Map

Documentation

The LITIENGINE documentation pages containing in-depth guides for LITIengine are currently in deployment. We're looking forward to your contributions!

⚠️ We are aware that there is currently a lack of documentation, but we're planning to document the most important parts of the library and use-cases with the first beta release to ensure that features don't get deprecated before they're even used.

If you are searching for a particular method or class within the API or just want to further explore the engine's possiblities, the Javadocs are a good place to start.

Javadocs

Questions?

Visit the official LITIENGINE forum for troubleshooting or to learn about the LITIENGINE community. If you encounter bugs or want to request fancy new features, you can also open an issue in our Issue Tracker.

Libraries Used

utiLITI

Contributing

Citations

If you want to cite parts of the LITIengie in your academic work, you can use the following Digital Object Identifier:

DOI

Contacts

Authors

Gurkenlabs

Gurkenlabs is an indie game development project by two brothers from Bavaria:

Support the devs