roboknight5 / fastj

An open-source, Java-based 2D game engine.

What is FastJ?

FastJ is an open-source, Java-based 2D game engine and framework. Originally named the FastJ Engine, it aims to provide an easy-to-use, 2D game-making library.

Disclaimer

This project is still under heavy development. There is a very good chance bugs are still prevalent and untracked, as the engine is not fully covered by unit tests. Documentation is readily available, but may change over time. If you would like to help out, all help is appreciated!

Projected Feature List

Feature	Description	Support
2D Rendering	Rendering of 2D Polygons, Models, Lighting	✔
Scene System	Scene-based Rendering, Scene Switching	✔
Scriptable Behaviors	Control game object states through behaviors.	✅
Desktop Support	Full Compatibility on Windows, Linux, and macOS.	✅
Audio Engine	Play sounds of several different formats at any given time.	✔
Image Support	Image rendering, transformations, and sprite animation.	❌
Animation Support	Interpolation and tweening framework.	❌
UI System	Flexible UI system to replace the need for Swing UI.	⭕
FastJ Model Creator	Create & Export 2D Models quickly and easily.	❌
FastJ Editor	View, Run, Build, and Export FastJ games from an editor.	❌
Web Support	Compile FastJ games to run in a browser.	❌

✅ is complete and satisfactory.

✔ is implemented and usable, but is missing certain features.

⭕ is in progress.

❌ is not yet implemented.

Learning FastJ

Template Projects

Check out these template projects for FastJ! They're the fastest way to jump right into using FastJ.

• Java: https://github.com/lucasstarsz/fastj-java-template
• Kotlin: https://github.com/lucasstarsz/fastj-kotlin-template
• Groovy: https://github.com/lucasstarsz/fastj-groovy-template

Examples

There will likely be a small wiki added for this game engine at a later time. For now, you'll want to check out the example projects for getting started with FastJ.

Documentation

From there, explore the example code, play around with it, and read the API documentation to get a better understanding of FastJ.

Adding FastJ to your project without a template

This library can be found in the following places:

• Maven Central, as a dependency or as a jarfile.
• The Releases section of this repository.

Adding the Dependency

When adding the dependency, make sure to replace [latest version here] with the actual latest version (you'll find this in the Maven Central link up above). The current latest version is 1.4.0.

A few common dependencies are provided below:

• Gradle
  • Groovy:

    implementation 'io.github.lucasstarsz.fastj:fastj-library:[latest version here]'

  • Kotlin:

    implementation("io.github.lucasstarsz.fastj:fastj-library:[latest version here]")

• Maven

  <dependency>
    <groupId>io.github.lucasstarsz.fastj</groupId>
    <artifactId>fastj-library</artifactId>
    <version>[latest version here]</version>
  </dependency>

• Apache Ivy

  <dependency org="io.github.lucasstarsz.fastj" name="fastj-library" rev="[latest version here]" />

Contributing to FastJ

Plan on contributing to the repository? Great! Be sure to read over the contribution guidelines.

Building FastJ

You'll need a few things in order to work on the repository:

• Git
• Java 11
• (optional, but highly recommended!) A decent understanding of how to use Gradle. Installation of Gradle is not required -- the project supplies the Gradle tools already.
  • For reference, this project currently makes use of Gradle 7.1.1.

Once you have what you need, follow these simple steps:

• Clone the FastJ repository.

  git clone https://github.com/fastjengine/FastJ.git

• Build the project.

  ./gradlew build

  Having trouble using gradlew? Read this.

License

This repository is licensed under the MIT License.