Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 3.37 KB

readme.md

File metadata and controls

51 lines (34 loc) · 3.37 KB
Raw

FAF logo

Downlord's FAF Client

Build Status Coverage Status

The official client for Forged Alliance Forever (FAF)

Support development

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

Issue hunt

How to run

  1. Use AdoptOpenJDK 14 or Oracle JDK 14 (others might not work)
  2. 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
  3. Open the project into IntelliJ IDEA Ultimate or Community (free)
  4. Make sure you have the IntelliJ IDEA Lombok plugin installed
  5. Make sure you have Enable annotation processing enabled in the settings
  6. Select Main as run configuration next to the hammer button in the top right
  7. Compile and start the application by pressing the play button

A video tutorial is available here. Don't forget step 5. If you want to use the Scene Builder, please import jfoenix.

Linux

Learn how to install the client on Linux here

Open Source licenses
Thanks to ej-technologies for their open source license. We use Install4j to build installers.
Thanks to bugsnag for their open source license. We use bugsnag for our error reporting.
Thanks to YourKit for their open source license

Contribute

Please take a look at the contribution guidelines before creating a pull request

Have a look at our wiki.