readme.md

FAF Client

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. 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.

How To Run

1. Use Temurin 21 or Oracle JDK 21 (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 Enable annotation processing enabled in the settings
5. Select Main as run configuration next to the hammer button in the top right
6. Compile and start the application by pressing the play button

A video tutorial is available here. Don't forget to Enable annotation processing.

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.
	Thanks to Twemoji Twitter for their open source license. We use and display emojis in the chats.

Contribute

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

Have a look at our wiki.