This project provides Java bindings for the rich presence portion of the Discord GameSDK.
The intent of this fork is to provide rich presence support for Wynntils/Artemis. Changes from the original project include proper documentation for building native libraries from source, as well as macOS ARM support along with code refactorings.
If you are just looking for an alternative to the deprecated Discord Rich Presence SDK, check out ActivityManager.
If you are using this as a part of a Minecraft mod, it is highly recommended that you run callbacks in a TickEvent or in a separate thread.
There are pre-compiled builds on Github Packages.
For projects not using any build tools, download a pre-compiled JAR-file (antiope-<version>.jar)
from the releases page.
If you want, you can also download the sources (antiope-<version>-sources.jar).
You do not need to download the .dll or .so files! They are packed in the JAR and will be automatically extracted.
After downloading those JARs, just add the main JAR to your project's classpath.
Build (and install) the library with Maven:
mvn clean install -Dmaven.antrun.skip=trueThis is required for any changes to the C code.
This guide is for WSL (Ubuntu) and it also probably works on normal Linux. It definitely does not work on macOS/Windows.
Start by installing a lot of dependencies:
sudo apt update
sudo apt install -y clang cmake make libssl-dev liblzma-dev lzma-dev libxml2-dev libbz2-dev
sudo apt install -y g++-mingw-w64-i686 g++-mingw-w64-x86-64 gcc-mingw-w64-i686 gcc-mingw-w64-x86-64 openjdk-11-jdkAnd also download Maven if you don't have it. Extract it somewhere and add the bin folder to your PATH.
It is possible to download Maven to the host Windows machine and add it to Windows' PATH.
By default, this will also make them available in WSL.
Note that you can access Windows host machine files from WSL at /mnt/c/ (or any other drive letter).
At this point, you should have folder /usr/lib/jvm with some copies of your Linux JDK.
Ensure your JAVA_HOME is pointed to the correct directory (probably some variation of /usr/lib/jvm/java-11-openjdk-amd64/).
You can check with echo $JAVA_HOME.
If it's not there, you should create a .sh file in /etc/profile.d/ with the following contents (filename does not matter):
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64Then reload by logging out and back in (reconnect ssh session or close WSL window).
You will need to download copies of OpenJDK 11 for Windows x64, macOS x64 and macOS aarch64. The compressed archive version, not the installer.
Unzip each archive and place them in /usr/lib/jvm.
You should rename the folders to windows-x64-jdk-11.0.19, macos-x64-jdk-11.0.19 and macos-aarch64-jdk-11.0.19 respectively.
If you are using 11.0.19 and have named the folders exactly like the above, you can skip this next step.
If your JDK versions are different, you will need to update the .cmake files in the toolchains folder.
For each file, there are paths pointing to the JDKs. Simply edit them so the paths point to your jdk folders.
Nothing to do! Everything has been completed in the previous steps already.
For macOS, this part is a bit more complicated.
You will need to follow the instructions here, but they are slightly wrong.
In ~, clone the repository. (git clone https://github.com/tpoechtrager/osxcross)
You should be using the "Packing the SDK on Linux - Method 1 (Xcode > 8.0)" option. Xcode version 12.5.1 is tested and working. Version 14.3.1 and newer does not work. These docs assume you are using 12.5.1. After that, you can skip step 2. We have installed the correct dependencies already, and the ones listed here are wrong. Finish with steps 3 and 4 as normal.
Once you do the above, you can proceed to their installation instructions.
Again, note that the packages mentioned are wrong. You should exclude xz and libbz2. Do not run their get_dependencies.sh script, it does not work.
You can run ./build.sh immediately after manually ensuring that the dependencies are installed.
Next, install cctools from here. You do not need the TAPI library.
When you run ./configure, you should use the following command:
./configure --prefix=/home/<username>/cctools --target=aarch64-apple-darwin20.4(Replacing <username> with your username, and darwin20.4 if you are using some other Xcode version).
Complete installation as normal.
Now add both osxcross and cctools to PATH. As mentioned above in the prerequisites, you can create (or use your existing) .sh file in /etc/profile.d/.
Add the following contents:
export PATH=$PATH:$JAVA_HOME/bin:/home/<username>/cctools-port/cctools:/home/<username>/osxcross/target/bin(Again, replace <username> with your username).
Lastly, you will have to edit macos-amd64.cmake and macos-aarch64.cmake in the toolchains folder.
Search for the line set(CMAKE_C_FLAGS and change the username in the path to your own.
Finally, download Discord's native library
and extract it to ./discord_game_sdk/. You should be using v3.2.1 (or other compatible version) as v2.5.6 does not have ARM support.
The CMake build system is integrated in Maven, so just execute the following command.
mvn clean installThe output dll/so/dylib files will be placed in the target/native directory. For convenience, you can run copy-natives.sh to copy them to src/main/resources/native.
Once you copy them over, you can run test.java (changing the client ID to your own application) to test if it works.
If "got new core" is printed out, that specific platform is working.
In code, the first step is initializing the Core. To do this you need to pass the path to Discord's native library as an argument.
You can find this library in the directory you just extracted the ZIP file at lib/x86_64/discord_game_sdk.dll (for 64-bit Windows)
and lib/x86_64/discord_game_sdk.so (for 64-bit Linux):
DiscordGameSDKCore.loadLibrary();Now you are ready to use the library!
class Example {
public static void main(String[] args) {
try {
CreateParams params = new CreateParams();
params.setClientID(APPLICATION_ID_AS_LONG);
params.setFlags(CreateParams.getDefaultFlags());
DiscordGameSDKCore core = new DiscordGameSDKCore(params);
try {
// do something with your Core
}
}
}
}