README.md

About

JavaFX Game Development Framework

Why FXGL?

• No native libraries, no installation, no setup required
• "Out of the box": Java 8/9, Win/Mac/Linux/Android 5.0+(Sample)/iOS(alpha)/Web(alpha)
• Simple and clean API
• Superset of JavaFX: no need to learn new UI API
• Brings real-world game development techniques to JavaFX
• Games are easily packaged into a single executable .jar

Good for:

• Any 2D genre (side-scroller / platformer / arcade / RPG)
• Complex UI controls
• Hobby / academic / commercial projects
• Teaching / learning / improving game development skills
• Fast prototyping of game ideas

Features

• More than 60 major features
• Showcase

Minimal Example

public class BasicGameApp extends GameApplication {

    @Override
    protected void initSettings(GameSettings settings) {
        settings.setWidth(800);
        settings.setHeight(600);
        settings.setTitle("Basic Game App");
    }

    public static void main(String[] args) {
        launch(args);
    }
}

Getting Started

• Wiki & Written tutorials
• YouTube tutorials
• Sample code demos
• Game demos (src)
• Game demos (.jar)

Maven

• Maven project if you use Java
• Maven project if you use Kotlin

Already have pom.xml? Then add:

<dependency>
    <groupId>com.github.almasb</groupId>
    <artifactId>fxgl</artifactId>
    <version>0.5.1</version>
</dependency>

Gradle

• Gradle project if you use Java
• Gradle project if you use Kotlin

Already have build.gradle? Then add:

repositories {
    jcenter()
}

dependencies {
    compile 'com.github.almasb:fxgl:0.5.1'
}

Uber jar

Download the latest uber jar from Releases

Community

• University of Brighton, UK
• University of Nottingham, UK
• Walton High School, USA
• Zealand Institute of Business and Technology, Denmark

If your institution wants to use / is using FXGL, drop me an email to discuss how FXGL can aid your course.

Contribution & Support

If you want to build FXGL from sources or want to contribute, please see the Contribution Guide (including non-code).

You can support the FXGL development via PayPal or simply star the repo to show interest.

Contact

• Ask questions on StackOverflow with tags javafx and fxgl
• Tweet with #fxgl
• Chat with the friendly FXGL community
•