Skip to content

Latest commit

 

History

236 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Omicron

Build Contributors

Omicron is an open source Game Engine for Java based on LibGDX, inspired by Fantasy Consoles. Write your retro games with the simplest possible API and either package it as a cartridge, or include the runtime in your own distribution!

Features:

  1. Super simple API, just a bunch of methods for drawing, playing sound, handling input, etc.
  2. No resource management: just refer to the thing you want to draw or play by it's number.
  3. Work on desktop and android (there's also an experimental libretro core)
  4. Plaform independent API
  5. Customizable resolution and scaling

Included demos

Feature Demo, showing off most of the features:

Play in your browser

Feature Demo example

Alien Buster, an included micro game:

Play in your browser

A screenshot from the demo

Snake a complete Snake game:

Play in your browser

image

Real games:

An open source videogame developed with Omicron, Doors of Doom, available on FDroid - (sources):

Doors of Doom

Retrodrawing, a simple drawing app with big pixels:
Retrodrawing

Turns of War an open source turn based strategy game made with Omicron:
image

Architecture

Omicron can work as a game engine (as a dependency in a standalone project) or as a Fantasy Console (Omicron itself is executed and it runs omicron cartridges).

Cartridges are maven projects with a standardized pom.xml which can be run on the fly or produces an .omicron cartridge file.

A maven archetype is available to produce a preconfigured cartridge projects ready to run.

Some wrappers are available that take a cartridge and produce an android, web or desktop app.

How can I try it?

Quickest start:

  1. Build and install the omicron-player project:
  • cd omicron-player\
  • mvn clean install package
  1. Run a demo:
  • cd demo/snake
  • mvn clean compile exec:exec

You can also run Omicron itself as a Fantasy Console:

  1. Generate a demo cartridge
  • cd demo/snake
  • mvn clean package
  1. Run the player jar in omicron-assembly/target:
  • java -jar omicron.jar
  1. Open a cartrigde (demo/snake/snake.omicron)

Generate your own cartridge:

You can generate a preconfigured, ready to run project with the following command:

  • mvn archetype:generate -DarchetypeGroupId=com.github.msx80.omicron -DarchetypeArtifactId=omicron-archetype -DarchetypeVersion=0.0.13-SNAPSHOT

Then run it with:

  • cd mygame
  • mvn clean compile exec:exec

The API

Omicron has a minimalistic and self-explanatory API. Take a look at it here for the full API!

Get Started

Take a look at the Hello World example to get a feeling!

Then head to the wiki for some documentation!

About

a Java Fantasy Console/Game Engine

Resources

Stars

33 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages