litiengine: A Java repository from Gurkenlabs

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.

🎮 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

🐘 Gradle

The LITIENGINE Java library is hosted on the Maven Central Repository, i.e. fetching it with Gradle is as simple as configuring your source repository and defining the dependency as shown below.

Groovy syntax:

repositories {
    mavenCentral()
}

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

Kotlin Syntax:

repositories {
    mavenCentral()
}

dependencies {
  implementation("de.gurkenlabs:litiengine:0.8.0")
}

Other ways of installing and using LITIENGINE

For alternative ways of downloading and applying LITIENGINE to your project, visit our Getting Started Guide.

📚 Documentation

The LITIENGINE documentation contains in-depth explanations, guides, and tutorials for general concepts of the engine.

Javadocs

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

Questions

You've found yourself trying to work out a feature of the engine that is not yet documented? Join our community in the LITIENGINE forum hosted on Github or on Discord for troubleshooting.

Bugs and Issues

You've encountered an obvious issue or bug with LITIENGINE or want to request enhancements and features? File an issue in our Issue Tracker.

📦 Libraries Used

JInput for Gamepad support
MP3 SPI for .mp3 support
Ogg Vorbis SPI for .ogg support

utiLITI

Darklaf for theming support

Other Recommended Libraries

Steamworks4j for supporting the steamworks SDK

🤝 Contributing

If you've decided to help out with LITIENGINE's development - you're awesome! And here's what you need to to:

Agree to our Code of Conduct
View our Contribution guidelines

Star History (Compared with other 2D java game libraries / frameworks / engines)

Contact

LITIENGINE is created by two Bavarian brothers known as gurkenlabs:


Steffen Wilke	Matthias Wilke
steffen-wilke	nightm4re94

gurkenlabs/litiengine