faf-java-commons

A library of shared code for the FAForever java projects:

• FAF API
• FAF client
• FAF moderator client

Modules

This repository contains 3 standalone modules:

• API contains code to interact with the FAF API
• Lobby contains code to interact with the FAF Lobby server.
• Data contains code to interact with FAF and SupCom file formats in general.

Versioning and compatibility

This project does not follow semantic versioning. The published packages follow a <YYMMDD>-<git commit hash> pattern to always suggest the latest version.

There might be breaking changes. We always enforce compatibility to the most recent API.

This project does not ensure backwards compatibility for 3rd party applications. Use at your own risk.

Releasing

The project is released on maven central.

It also can be released on Jitpack but with its special Jitpack group id. We no longer ensure a working Jitpack release.

Maintainer info: To release a new version, trigger the Publish package to MavenCentral Github action. Afterwards it needs to be published on Sonatype with the FAForever user. It always takes some time to show up afterwards.