fortnite-2-xmpp

A Java 11+ client for Fortnite's XMPP services

Features

• Ability to send chat messages and process inbound chat messages
• Ability to process friends list received after connecting
• Ability to process friends' presence updates

Installation

Maven

<properties>
  ...
  <!-- Use the latest version whenever possible. -->
  <fortnite-2-xmpp.version>1.0.0</fortnite-2.version>
  ...
</properties>

<dependencies>
  ...
  <dependency>
    <groupId>io.github.robertograham</groupId>
    <artifactId>fortnite-2-xmpp</artifactId>
    <version>${fortnite-2-xmpp.version}</version>
  </dependency>
  ...
</dependencies>

Usage

Instantiating a client

This is the simplest way to instantiate a client:

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

public final class Main {

    public static void main(final String[] args) {
        final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
            .build();
        final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
            .build();
    }
}

By default fortnite-2-xmpp will not debug raw XMPP traffic but this can be enabled like so:

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

public final class Main {

    public static void main(final String[] args) {
        final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
            .build();
        final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
            .setDebugXmppConnections(true)
            .build();
    }
}

The platform and application the authenticated user is using can be spoofed like so:

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

public final class Main {

    public static void main(final String[] args) {
        final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
            .build();
        final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
            .setApplication(Application.FORTNITE_CLIENT)
            .setPlatform(Platform.NINTENDO_SWITCH)
            .build();
    }
}

Cleaning up

When you no longer need your client instance, remember to close your XMPP connections with a call to FortniteXmpp.close(). Usage examples further in this document will make this call implicitly using try-with-resources statements.

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

public final class Main {

    public static void main(final String[] args) {
        final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
            .build();
        final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
            .build();
        fortniteXmpp.close();
        fortnite.close();
    }
}

Listeners

Register an OnFriendsListReceivedListener that prints the Account representation of every friend

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

import java.io.IOException;

public final class Main {

    public static void main(final String[] args) {
        try (
            final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
                .build();
            final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
                .setOnFriendsListReceivedListener((final var accountIds, final var friend) -> {
                    try {
                        fortnite.account()
                            .findAllByAccountIds(accountIds.toArray(String[]::new))
                            .ifPresent((final var accounts) -> accounts.forEach(System.out::println));
                    } catch (final IOException exception) {
                        // findAllByAccountIds unexpected response
                    }
                })
                .build()
        ) {
        }
    }
}

Register an OnFriendPresenceReceivedListener that stores friends and their presence details in a Map

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.domain.Session;
import io.github.robertograham.fortnite2.xmpp.domain.enumeration.Status;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

import java.util.AbstractMap.SimpleEntry;
import java.util.HashMap;
import java.util.Map.Entry;

public final class Main {

    public static void main(final String[] args) {
        final var accountIdToStatusSessionEntryMap = new HashMap<String, Entry<Status, Session>>();
        try (
            final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
                .build();
            final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
                .setOnFriendPresenceReceivedListener((final var accountId, final var status, final var sessionOptional, final var friend) ->
                    accountIdToStatusSessionEntryMap.put(accountId, new SimpleEntry<>(status, sessionOptional.orElse(null)))
                )
                .build()
        ) {
            while (accountIdToStatusSessionEntryMap.isEmpty())
                System.out.println("Awaiting presence");
            accountIdToStatusSessionEntryMap.forEach((final var accountId, final var statusToSessionEntry) ->
                System.out.printf("%s[%s]: %s\n", accountId, statusToSessionEntry.getKey(), statusToSessionEntry.getValue())
            );
        }
    }
}

Chat API

Register an OnChatMessageReceivedListener, send a message to the authenticated account and wait for the message to be self-received

import io.github.robertograham.fortnite2.implementation.DefaultFortnite;
import io.github.robertograham.fortnite2.xmpp.implementation.DefaultFortniteXmpp;

import java.io.IOException;

public final class Main {

    public static void main(final String[] args) {
        try (
            final var fortnite = DefaultFortnite.Builder.newInstance("epicGamesEmailAddress", "epicGamesPassword")
                .build();
            final var fortniteXmpp = DefaultFortniteXmpp.Builder.newInstance(fortnite)
                .setOnChatMessageReceivedListener((final var accountId, final var messageBody, final var chat) ->
                    System.out.printf("New message from %s!%n", accountId)
                )
                .build()
        ) {
            final var sessionAccount = fortnite.account()
                .findOneBySessionAccountId()
                .orElseThrow();
            fortniteXmpp.chat()
                .sendMessageToAccount(sessionAccount, "WE LOVE FORTNITE WE LOVE FORTNITE");
            while (fortniteXmpp.chat()
                .findAllMessagesReceivedFromAccount(sessionAccount)
                .isEmpty()) ;
            fortniteXmpp.chat()
                .findAllMessagesReceivedFromAccount(sessionAccount)
                .forEach(System.out::println);
        } catch (final IOException exception) {
            // findOneBySessionAccountId unexpected response
            // OR sendMessageToAccount failed
        }
    }
}