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: about 4 hours 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 (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2024-06-04T14:46:50.000Z (4 months ago)
• Last Synced: 2024-06-04T17:49:16.755Z (4 months 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: 33.5 MB
• Stars: 189
• Watchers: 21
• Forks: 117
• Open Issues: 107
• 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/)

## Support Development

Post a bounty on Issue Hunt. You can reward and financially help developers that solve the issue. For new features, it can be helpful to first ask whether other people also see your change as an improvement. This helps avoid feature requests that will not be accepted.

[![Issue hunt](https://github.com/BoostIO/issuehunt-materials/raw/master/v1/issuehunt-button-v1.svg?sanitize=true)](https://issuehunt.io/r/FAForever/downlords-faf-client)

## How To Run

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

1. Clone the project with Git

    - using SSH: `git clone [email protected]: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).