https://github.com/faforever/downlords-faf-client

Official client for Forged Alliance Forever
https://github.com/faforever/downlords-faf-client

client faforever gaming gradle install4j intellij issue-hunt java javafx javafx-application oauth2-client opensource spring spring-boot

Last synced: 5 months ago
JSON representation

Official client for Forged Alliance Forever

• Host: GitHub
• URL: https://github.com/faforever/downlords-faf-client
• Owner: FAForever
• License: mit
• Created: 2015-03-26T09:47:32.000Z (about 11 years ago)
• Default Branch: develop
• Last Pushed: 2025-05-09T08:46:57.000Z (about 1 year ago)
• Last Synced: 2025-05-09T09:35:03.422Z (about 1 year ago)
• Topics: client, faforever, gaming, gradle, install4j, intellij, issue-hunt, java, javafx, javafx-application, oauth2-client, opensource, spring, spring-boot
• Language: Java
• Homepage: https://faforever.com
• Size: 34.1 MB
• Stars: 203
• Watchers: 19
• Forks: 125
• Open Issues: 114
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  


# FAF Client

[![Checks](https://github.com/FAForever/downlords-faf-client/actions/workflows/checks.yml/badge.svg?branch=develop)](https://github.com/FAForever/downlords-faf-client/actions/workflows/checks.yml)

[![Coverage Status](https://coveralls.io/repos/github/FAForever/downlords-faf-client/badge.svg?branch=develop)](https://coveralls.io/github/FAForever/downlords-faf-client?branch=develop)

The official client for [Forged Alliance Forever (FAF)](https://www.faforever.com/)

## How To Run

1. Use [Temurin](https://adoptium.net/) 25 or Oracle JDK 25 (others might not work)

1. Clone the project with Git

    - using SSH: `git clone git@github.com:FAForever/downlords-faf-client.git`

    - using HTTPS: `https://github.com/FAForever/downlords-faf-client.git`

1. Open the project into [IntelliJ IDEA](https://www.jetbrains.com/idea/) Ultimate or Community (free)

1. Make sure you have `Enable annotation processing` enabled in the settings

1. Select `Main` as run configuration next to the hammer button in the top right

1. Compile and start the application by pressing the play button

A video tutorial is available [here](https://youtu.be/6gsHnt02I_Y). Don't forget to `Enable annotation processing`.

### Linux

Learn how to install the client on Linux [here](https://github.com/FAForever/downlords-faf-client/wiki/Install-on-Linux).

## Open Source Licenses

|                                                                                                                                                |                                                                                                                                                                                               |

|----------------|-------------------------------|

|                                              | Thanks to [ej-technologies](https://www.ej-technologies.com) for their [open source license](https://www.ej-technologies.com/buy/install4j/openSource). We use Install4j to build installers. |

|            | Thanks to [bugsnag](https://www.bugsnag.com) for their [open source license](https://www.bugsnag.com/open-source/). We use bugsnag for our error reporting.                                   |

|| Thanks to [YourKit](https://www.yourkit.com) for their open source license.|

|  | Thanks to [Twemoji Twitter](https://twemoji.twitter.com/) for their open source license. We use and display emojis in the chats.                                                              |

## Contribute

Please take a look at the [contribution guidelines](https://github.com/FAForever/java-guidelines/wiki/Contribution-Guidelines) before creating a pull request.

Have a look at our [wiki](https://github.com/FAForever/downlords-faf-client/wiki).