FAF Moderator Client

This application enables faforever.com moderators to perform administrative actions. This involves:

managing of users, user groups and permissions
uploading and assigning avatars
managing matchmaker map pools
map & mod vault
checking recent activities
editing runtime translations

How to use / run it

Make sure you have Java 21 or higher installed (JRE or JDK does not matter). Adoptium offers free installation packages here (other Java flavours like Oracle should also work)
Download the right client version for your operating system from the release page
Unzip it
Go to the bin folder and run the .bat script (Windows) or the .sh script (Linux)
Login with your FAF credentials

Setting up your environment

Recommended software

We recommend JetBrains IntelliJ as IDE. The community edition is free and open source.
For editing the user interface, we strongly recommend Scene Builder
For a simple setup and testing of the dependencies you should use Docker and Docker Compose

Boot the dependencies

Checkout the FAF Stack and initialize the database (scripts/init-db.sh). Afterwards boot the api via docker-compose up -d faf-java-api.
Get some test data and insert it into the MySQL db ( user: root & password: banana). A tool like HeidiSQL can help you with this. This also adds a moderator account with username: test & password: test_password

Run from source

Clone the project with git
Import the project into IntelliJ as "Gradle Project"
Make sure you have the IntelliJ Lombok plugin installed
Make sure you have Enable annotation processing enabled in the settings
Add the dev profile as command line options ("VM options" in IntelliJ) using -Dspring.profiles.active=dev
Add your platform as parameter for all Gradle processes e.g. -PjavafxPlatform=win for Windows.