README.md

About

JavaFX Game Development Framework

Why FXGL?

• No installation or setup required
• "Out of the box": Java 8-17, Win/Mac/Linux/Android 8+/iOS 11.0+/Web
• Simple and clean API, higher level than other engines
• Superset of JavaFX: no need to learn new UI API
• Real-world game development techniques: Entity-Component, interpolated animations, particles, and many more
• Games are easily packaged into a single executable .jar or native images

Good for:

• Any 2D game (side-scroller / platformer / arcade / RPG)
• Any business application with complex UI controls / animations
• Experimental 3D
• Hobby / academic / commercial projects
• Teaching / learning / improving game development skills
• Fast prototyping of app ideas

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

For a quick dive into code, see standalone basic examples. Otherwise, see:

• Showcase Trailer
• Use FXGL with IntelliJ
• Wiki & written tutorials
• YouTube tutorials
• Sample code demos
• FXGL games (with source)
• Published demos on itch.io

Maven

• Maven template project if you use Java and/or Kotlin (Java 17+)

Make sure to set <release>17</release> for maven-compiler-plugin.

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

Note: use 0.5.4 for Java 8-10 and 11.17 for Java 11-16.

Gradle

• Gradle template project if you use Java and/or Kotlin (Java 17+)

Please refer to the template if there are any errors.

repositories {
    jcenter()
}

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

Note: use 0.5.4 for Java 8-10 and 11.17 for Java 11-16.

Modularity

If you wish to develop a modular application, here's a complete example of your module-info.java:

open module app.name {
    requires com.almasb.fxgl.all;
}

Uber jar

Download the latest uber jar from Releases

Community

• University of Brighton, UK
• University of Nottingham, UK
• Georgia Institute of Technology, USA
• kidOYO, USA
• Walton High School, USA
• Conant High School, USA
• Zealand Institute of Business and Technology, Denmark
• Federal Institute of Education, Science and Technology of Rio Grande do Sul, Brazil
• FHNW School of Engineering / Computer Science, Switzerland

If your institution wants to use or is using FXGL, add a note in the Chat to be added to the list.

Community tutorials:

• Space Ranger at journaldev
• Geometry Wars at webtechie
• Mazela-Man by dykstrom

Community projects (identified using fxgl topic):

• SOFTKNK.IO
• Consume
• FXGL Sliding Puzzle

If you'd like your project featured here, just add a note in the Chat.

Development Team

Description of roles is given in the Contribution Guide.

Maintainers (Collaborators):

• Almas Baimagambetov

Coordinators:

• Adam Bocco

Testers:

• Carl Dea
• Frank Delporte

Contribution & Support

If you want to build FXGL from sources or want to contribute, please see the Contribution Guide (including non-code). FXGL is fully modular, so new contributors do not need to understand the entire codebase, only the module to which the contribution is made. Contributions will be reviewed in accordance with the Code of Conduct.

You can support the FXGL development or show interest by simply starring the repo or becoming a sponsor.

Sponsors

Users:

• @Marsl10
• @SergeMerzliakov
• @mbains
• @sabit86
• @hendrikebbers
• @ImperaEtConquer
• @thejeed

Companies:

• @karakun

Contact

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