Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JnCrMx/discord-game-sdk4j
Java bindings for Discord's Game SDK
https://github.com/JnCrMx/discord-game-sdk4j
bindings discord discord-gamesdk java
Last synced: 2 months ago
JSON representation
Java bindings for Discord's Game SDK
- Host: GitHub
- URL: https://github.com/JnCrMx/discord-game-sdk4j
- Owner: JnCrMx
- License: mit
- Created: 2020-04-12T12:22:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T13:16:32.000Z (5 months ago)
- Last Synced: 2024-08-22T14:55:40.394Z (5 months ago)
- Topics: bindings, discord, discord-gamesdk, java
- Language: Java
- Homepage:
- Size: 310 KB
- Stars: 110
- Watchers: 4
- Forks: 23
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-discord - discord-game-sdk4j - Java bindings for the Discord Game SDk. (Game SDK & RPC Bindings)
README
# discord-game-sdk4j
[](https://jitpack.io/#JnCrMx/discord-game-sdk4j)
[](https://docs.jcm.re/discord-game-sdk4j/)
This project provides Java bindings for the
[Discord GameSDK](https://discordapp.com/developers/docs/game-sdk/sdk-starter-guide).
To be honest I'm not sure if people even need this, because Discord apparently discarded its game store idea.
But maybe the activity, overlay, user, and relationship features could be useful to some people.
## Rich Presence
If you are just looking for an alternative to the deprecated [Discord Rich Presence SDK](https://discord.com/developers/docs/rich-presence/how-to),
head over to the [ActivityExample.java](examples/ActivityExample.java)!
## Features of the SDK
**Some of the features are deprecated by Discord as of Wed, 09 Nov 2022 and will be decommissioned and stop working on Tuesday May 2, 2023.
They are marked with :broken_heart: in the table.
Those already implemented will most likely continue to work until Discord decommissions them.
Those not implemented will remains such, as putting work into features which will end working in less than a year does not seem worth it to me.**
**The Java-only implementation currently does not support all features fully.
I am aiming to fully implement all non-deprecated features soon.**
| Feature | State | Example |
|-----------------------------------------------------------------------------|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| [Achievements](https://discord.com/developers/docs/game-sdk/achievements) | 🔴 💔 not implemented | |
| [Activities](https://discord.com/developers/docs/game-sdk/activities) | 🟡 ❤️ partially implemented[^activities] | [ActivityExample.java](examples/ActivityExample.java) |
| [Applications](https://discord.com/developers/docs/game-sdk/applications) | 🟡 💔 partially implemented[^applications] | |
| [Voice](https://discord.com/developers/docs/game-sdk/discord-voice) | 🟢 💔 implemented | |
| [Images](https://discord.com/developers/docs/game-sdk/images) | 🟢 💔 implemented | none yet :cry: (see [``imageTest()``](src/test/java/de/jcm/discordgamesdk/DiscordTest.java#L417) for now) |
| [Lobbies](https://discord.com/developers/docs/game-sdk/lobbies) | 🔴 💔 not implemented | |
| [Networking](https://discord.com/developers/docs/game-sdk/networking) | 🔴 💔 not implemented | |
| [Overlay](https://discord.com/developers/docs/game-sdk/overlay) | 🟢 ❤️ implemented | none yet :cry: (see [``overlayTest()``](src/test/java/de/jcm/discordgamesdk/DiscordTest.java#L289) for now) |
| [Relationships](https://discord.com/developers/docs/game-sdk/relationships) | 🟢 ❤️ implemented | [RelationshipExample.java](examples/RelationshipExample.java), [FriendNotificationExample.java](examples/FriendNotificationExample.java) |
| [Storage](https://discord.com/developers/docs/game-sdk/storage) | 🔴 💔 not implemented | |
| [Store](https://discord.com/developers/docs/game-sdk/store) | 🔴 💔 not implemented | |
| [Users](https://discord.com/developers/docs/game-sdk/users) | 🟡 ❤️ partially implemented[^users] | none yet :cry: (see [``userTest()``](src/test/java/de/jcm/discordgamesdk/DiscordTest.java#L216) for now) |
[^activities]: The methods `registerCommand` and `registerSteam` are not implemented, because they simply create shortcuts.
The method `acceptRequest` is not implemented, because I cannot figure out how it works. Help is appreciated! 😄
[^applications]: Only the method `getOAuth2Token` and the custom more exhaustive method `authenticate` are implemented.
[^users]: The method `getCurrentUserPremiumType` is not implemented because I don't have Discord Nitro, so I cannot test it.
## Installation
### Pre-compiled
#### Maven, Gradle and other build tools
There are pre-compiled builds on [JitPack](https://jitpack.io/#JnCrMx/discord-game-sdk4j)
together with instructions how to use them for all common build tools.
#### Manual installation
For projects not using any build tools, download a pre-compiled JAR-file (``discord-game-sdk4j-.jar``)
from the [releases page](https://github.com/JnCrMx/discord-game-sdk4j/releases).
If you want, you can also download the JavaDocs (``discord-game-sdk4j--javadoc.jar``) or
the sources (``discord-game-sdk4j--sources.jar``).
After downloading those JARs, just add the main JAR to your project's classpath and optionally
attach sources or JavaDocs.
### Building from source
To install the library from source first of all clone the repository:
```shell script
git clone https://github.com/JnCrMx/discord-game-sdk4j.git
```
Finally build (and install) the library with Maven:
````shell script
mvn install
````
If you want to skip the tests (sometimes they fail for really weird reasons), add ``-DskipTests`` to the command arguments.
## Usage
Create a ``Core`` object to start using the library:
````java
try(CreateParams params = new CreateParams())
{
params.setClientID();
params.setFlags(CreateParams.getDefaultFlags());
try(Core core = new Core(params))
{
// do something with your Core
}
}
````
For real examples see the ``examples/`` directory in this repository.
### Environment Variables
#### `DISCORD_INSTANCE_ID`
This library supports using the `DISCORD_INSTANCE_ID` environment variable to select a Discord instance to use.
On Windows, this results in the socket `\\.\pipe\discord-ipc-${DISCORD_INSTANCE_ID}` being used.
This should equal the behaviour of the official native libraries.
On Linux however, there are multiple locations and sockets, which this library tries to support, but the offical
library does not.
Therefore, an order of instances is established as follows:
1. Discord instances running directly as host applications (i.e. `$XDG_RUNTIME_DIR/discord-ipc-{0,1,2,3,...}`).
The following directories (in the order given) are searched: `$XDG_RUNTIME_DIR`, `$TMPDIR`, `$TMP`, `$TEMP`.
2. Discord instances running as a Flatpak, whose socket is found in
`/app/com.discordapp.Discord`.
3. Discord instances running as a Snap, whose socket is found in
`/snap.discord`.
4. Discord instances running as a Snap with a different instance name (using the `experimental.parallel-instances` setting),
whose socket is found in `/snap.discord_${instance_name}` *in alphabetical order*.
**Example:**
Let's say there are a total of five Discord instances running.
Two of them are running on the host system directly, one is running as a Flatpak and one is running as a "normal"
Snap and one running as a Snap (with `experimental.parallel-instances`) as `discord_test`.
Then the two Discord instances on the host system get the `DISCORD_INSTANCE_ID` `0` and `1`.
The Flatpak one is getting the `DISCORD_INSTANCE_ID` `2` and the normal Snap one is getting the `DISCORD_INSTANCE_ID` `3`.
Lately, the Snap one installed as `discord_test` gets `DISCORD_INSTANCE_ID` `4`.
#### `DISCORD_IPC_PATH`
To make it possible to select one specific Discord instance, rather than relying on this ordering,
this library introduces the environment variable `DISCORD_IPC_PATH`.
If this variable is set, this library will **not search for any sockets at all**.
It will simply assume that a socket is preset at `$DISCORD_IPC_PATH` and use that one.
This can be useful for automated tests, that might break on changing Discord instances.