├── .gitattributes ├── settings.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── src └── main │ └── java │ └── club │ └── minnced │ └── discord │ └── rpc │ ├── package-info.java │ ├── DiscordUser.java │ ├── DiscordEventHandlers.java │ ├── DiscordRPC.java │ └── DiscordRichPresence.java ├── examples ├── kotlin │ └── club │ │ └── minnced │ │ └── discord │ │ └── rpc │ │ └── example │ │ └── Main.kt └── java │ └── ml │ └── yuuki │ └── chris │ └── rpc │ └── examples │ └── WindowTest.java ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=lf 2 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'java-discord-rpc' 2 | 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MinnDevelopment/java-discord-rpc/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | src/test/* 2 | out/* 3 | build/* 4 | .idea/* 5 | .classpath 6 | .settings/* 7 | bin/* 8 | .project 9 | .gradle/* 10 | .idea/ 11 | .settings/ 12 | build/ 13 | discord-rpc.iml 14 | gradle.properties -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri Dec 01 07:51:31 CET 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.0-bin.zip 7 | -------------------------------------------------------------------------------- /src/main/java/club/minnced/discord/rpc/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | /** 18 | * Java bindings for the official Discord RPC SDK. 19 | */ 20 | package club.minnced.discord.rpc; 21 | -------------------------------------------------------------------------------- /examples/kotlin/club/minnced/discord/rpc/example/Main.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | @file:JvmName("Main") 18 | package club.minnced.discord.rpc.example 19 | 20 | import club.minnced.discord.rpc.* 21 | import club.minnced.discord.rpc.DiscordEventHandlers.* 22 | import java.io.File 23 | import kotlin.concurrent.thread 24 | 25 | fun main(args: Array) { 26 | println("Initializing...") 27 | // if .application-id doesn't exist we hard fail here 28 | val applicationId = File(".application-id").readText() 29 | val steamId: String? = with (File(".steam-id")) { 30 | if (exists()) 31 | readText() 32 | else 33 | null 34 | } 35 | 36 | println("Starting RPC...") 37 | discord { 38 | val handlers = handlers { 39 | ready = OnReady { println("Ready!") } 40 | errored = OnStatus { code, message -> println("$code: $message") } 41 | } 42 | 43 | Discord_Initialize(applicationId, handlers, true, steamId) 44 | 45 | presence { 46 | details = "Undisclosed" 47 | state = "Free 4 All" 48 | startTimestamp = System.currentTimeMillis() / 1000 49 | 50 | largeImageKey = "map-desert" 51 | largeImageText = "Desert" 52 | smallImageKey = "char-robert" 53 | smallImageText = "Robert" 54 | } 55 | 56 | thread(name="RPC-Callback-Handler") { 57 | while (!Thread.currentThread().isInterrupted) { 58 | Discord_RunCallbacks() 59 | Thread.sleep(2000) 60 | } 61 | } 62 | } 63 | 64 | } 65 | 66 | fun discord(block: DiscordRPC.() -> Unit) = DiscordRPC.INSTANCE.apply(block) 67 | fun handlers(block: DiscordEventHandlers.() -> Unit) = DiscordEventHandlers().apply(block) 68 | fun DiscordRPC.presence(block: DiscordRichPresence.() -> Unit) { 69 | Discord_UpdatePresence(DiscordRichPresence().apply(block)) 70 | } 71 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /src/main/java/club/minnced/discord/rpc/DiscordUser.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.discord.rpc; 18 | 19 | import com.sun.jna.Structure; 20 | 21 | import java.util.Arrays; 22 | import java.util.Collections; 23 | import java.util.List; 24 | import java.util.Objects; 25 | 26 | /* 27 | typedef struct DiscordUser { 28 | const char* userId; 29 | const char* username; 30 | const char* discriminator; 31 | const char* avatar; 32 | } DiscordUser; 33 | */ 34 | 35 | /** 36 | * Struct binding for a discord join request. 37 | */ 38 | public class DiscordUser extends Structure 39 | { 40 | private static final List FIELD_ORDER = Collections.unmodifiableList(Arrays.asList( 41 | "userId", 42 | "username", 43 | "discriminator", 44 | "avatar" 45 | )); 46 | 47 | public DiscordUser(String encoding) { 48 | super(); 49 | setStringEncoding(encoding); 50 | } 51 | 52 | public DiscordUser() { 53 | this("UTF-8"); 54 | } 55 | 56 | /** 57 | * The userId for the user that requests to join 58 | */ 59 | public String userId; 60 | 61 | /** 62 | * The username of the user that requests to join 63 | */ 64 | public String username; 65 | 66 | /** 67 | * The discriminator of the user that requests to join 68 | */ 69 | public String discriminator; 70 | 71 | /** 72 | * The avatar of the user that requests to join 73 | */ 74 | public String avatar; 75 | 76 | @Override 77 | public boolean equals(Object o) 78 | { 79 | if (this == o) 80 | return true; 81 | if (!(o instanceof DiscordUser)) 82 | return false; 83 | DiscordUser that = (DiscordUser) o; 84 | return Objects.equals(userId, that.userId) 85 | && Objects.equals(username, that.username) 86 | && Objects.equals(discriminator, that.discriminator) 87 | && Objects.equals(avatar, that.avatar); 88 | } 89 | 90 | @Override 91 | public int hashCode() 92 | { 93 | return Objects.hash(userId, username, discriminator, avatar); 94 | } 95 | 96 | @Override 97 | protected List getFieldOrder() 98 | { 99 | return FIELD_ORDER; 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /src/main/java/club/minnced/discord/rpc/DiscordEventHandlers.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.discord.rpc; 18 | 19 | import com.sun.jna.Callback; 20 | import com.sun.jna.Structure; 21 | 22 | import java.util.Arrays; 23 | import java.util.Collections; 24 | import java.util.List; 25 | import java.util.Objects; 26 | 27 | /* 28 | typedef struct DiscordEventHandlers { 29 | void (*ready)(DiscordUser*); 30 | void (*disconnected)(int errorCode, const char* message); 31 | void (*errored)(int errorCode, const char* message); 32 | void (*joinGame)(const char* joinSecret); 33 | void (*spectateGame)(const char* spectateSecret); 34 | void (*joinRequest)(const DiscordUser* request); 35 | } DiscordEventHandlers; 36 | */ 37 | /** 38 | * Struct containing handlers for RPC events 39 | *
Provided handlers can be null. 40 | */ 41 | public class DiscordEventHandlers extends Structure 42 | { 43 | /** 44 | * Handler function for the ready event 45 | */ 46 | public interface OnReady extends Callback 47 | { 48 | void accept(DiscordUser user); 49 | } 50 | 51 | /** 52 | * Handler function for the exceptional events (error, disconnect) 53 | */ 54 | public interface OnStatus extends Callback 55 | { 56 | void accept(int errorCode, String message); 57 | } 58 | 59 | /** 60 | * Handler function for game update events (joinGame, spectateGame) 61 | */ 62 | public interface OnGameUpdate extends Callback 63 | { 64 | void accept(String secret); 65 | } 66 | 67 | /** 68 | * Handler function for user join requests 69 | */ 70 | public interface OnJoinRequest extends Callback 71 | { 72 | void accept(DiscordUser request); 73 | } 74 | 75 | private static final List FIELD_ORDER = Collections.unmodifiableList(Arrays.asList( 76 | "ready", 77 | "disconnected", 78 | "errored", 79 | "joinGame", 80 | "spectateGame", 81 | "joinRequest" 82 | )); 83 | 84 | /** 85 | * Called when the RPC connection has been established 86 | */ 87 | public OnReady ready; 88 | /** 89 | * Called when the RPC connection has been severed 90 | */ 91 | public OnStatus disconnected; 92 | /** 93 | * Called when an internal error is caught within the SDK 94 | */ 95 | public OnStatus errored; 96 | /** 97 | * Called when the logged in user joined a game 98 | */ 99 | public OnGameUpdate joinGame; 100 | /** 101 | * Called when the logged in user joined to spectate a game 102 | */ 103 | public OnGameUpdate spectateGame; 104 | /** 105 | * Called when another discord user wants to join the game of the logged in user 106 | */ 107 | public OnJoinRequest joinRequest; 108 | 109 | @Override 110 | public boolean equals(Object o) 111 | { 112 | if (this == o) 113 | return true; 114 | if (!(o instanceof DiscordEventHandlers)) 115 | return false; 116 | DiscordEventHandlers that = (DiscordEventHandlers) o; 117 | return Objects.equals(ready, that.ready) 118 | && Objects.equals(disconnected, that.disconnected) 119 | && Objects.equals(errored, that.errored) 120 | && Objects.equals(joinGame, that.joinGame) 121 | && Objects.equals(spectateGame, that.spectateGame) 122 | && Objects.equals(joinRequest, that.joinRequest); 123 | } 124 | 125 | @Override 126 | public int hashCode() 127 | { 128 | return Objects.hash(ready, disconnected, errored, joinGame, spectateGame, joinRequest); 129 | } 130 | 131 | @Override 132 | protected List getFieldOrder() 133 | { 134 | return FIELD_ORDER; 135 | } 136 | } 137 | -------------------------------------------------------------------------------- /examples/java/ml/yuuki/chris/rpc/examples/WindowTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package ml.yuuki.chris.rpc.examples; 18 | 19 | import club.minnced.discord.rpc.*; 20 | 21 | import javax.swing.*; 22 | import java.awt.*; 23 | import java.awt.event.*; 24 | 25 | public class WindowTest { 26 | 27 | public static void main(String args[]) { 28 | if (args.length == 0) { 29 | System.err.println("You must specify an application ID in the arguments!"); 30 | System.exit(-1); 31 | } 32 | DiscordRPC lib = DiscordRPC.INSTANCE; 33 | DiscordRichPresence presence = new DiscordRichPresence(); 34 | String applicationId = args.length < 1 ? "" : args[0]; 35 | String steamId = args.length < 2 ? "" : args[1]; 36 | 37 | DiscordEventHandlers handlers = new DiscordEventHandlers(); 38 | handlers.ready = (user) -> System.out.println("Ready!"); 39 | 40 | lib.Discord_Initialize(applicationId, handlers, true, steamId); 41 | 42 | presence.startTimestamp = System.currentTimeMillis() / 1000; // epoch second 43 | presence.endTimestamp = presence.startTimestamp + 20; 44 | presence.details = "Details here"; 45 | presence.state = "State here"; 46 | presence.partySize = 1; 47 | presence.partyMax = 4; 48 | lib.Discord_UpdatePresence(presence); 49 | 50 | Thread t = new Thread(() -> { 51 | while (!Thread.currentThread().isInterrupted()) { 52 | lib.Discord_RunCallbacks(); 53 | try { 54 | Thread.sleep(500); 55 | } catch (InterruptedException e) { 56 | lib.Discord_Shutdown(); 57 | break; 58 | } 59 | } 60 | }, "RPC-Callback-Handler"); 61 | t.start(); 62 | 63 | JFrame frame = new JFrame("Java-Discord RPC"); 64 | GridLayout frameLayout = new GridLayout(2, 1); 65 | frame.setLayout(frameLayout); 66 | 67 | JPanel top = new JPanel(); 68 | GridLayout topLayout = new GridLayout(2, 2); 69 | top.setLayout(topLayout); 70 | 71 | JPanel bottom = new JPanel(); 72 | GridLayout botLayout = new GridLayout(2, 3); 73 | bottom.setLayout(botLayout); 74 | 75 | 76 | // Details 77 | JLabel detailsLabel = new JLabel("Details"); 78 | detailsLabel.setHorizontalAlignment(SwingConstants.RIGHT); 79 | JTextField detailsText = new JTextField(presence.details); 80 | 81 | JLabel stateLabel = new JLabel("State"); 82 | stateLabel.setHorizontalAlignment(SwingConstants.RIGHT); 83 | JTextField stateText = new JTextField(presence.state); 84 | 85 | JTextField partySizeText = new JTextField(String.valueOf(presence.partySize)); 86 | JLabel partyLabel = new JLabel("of"); partyLabel.setHorizontalAlignment(SwingConstants.CENTER); 87 | JTextField partyMaxText = new JTextField(String.valueOf(presence.partyMax)); 88 | 89 | JButton submit = new JButton("Update Presence"); 90 | submit.addActionListener(e -> { 91 | presence.details = detailsText.getText(); 92 | presence.state = stateText.getText(); 93 | try { 94 | presence.partySize = Integer.parseInt(partySizeText.getText()); 95 | } catch (Exception ignored) {} 96 | try { 97 | presence.partyMax = Integer.parseInt(partyMaxText.getText()); 98 | } catch (Exception ignored) {} // if text isn't a number, ignore it 99 | 100 | lib.Discord_UpdatePresence(presence); 101 | }); 102 | 103 | top.add(detailsLabel); 104 | top.add(detailsText); 105 | top.add(stateLabel); 106 | top.add(stateText); 107 | 108 | bottom.add(partySizeText); 109 | bottom.add(partyLabel); 110 | bottom.add(partyMaxText); 111 | bottom.add(new JPanel()); 112 | bottom.add(submit); 113 | bottom.add(new JPanel()); // dummy components to center the update button 114 | 115 | frame.add(top); 116 | frame.add(bottom); 117 | 118 | frame.addWindowListener(new WindowAdapter() { 119 | 120 | @Override 121 | public void windowClosing(WindowEvent e) { 122 | e.getWindow().setVisible(false); 123 | t.interrupt(); 124 | } 125 | }); 126 | 127 | frame.pack(); 128 | frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE); 129 | frame.setLocationRelativeTo(null); 130 | frame.setVisible(true); 131 | 132 | } 133 | 134 | } 135 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [bintray-version]: https://api.bintray.com/packages/minndevelopment/maven/java-discord-rpc/images/download.svg 2 | [bintray-download]: https://bintray.com/minndevelopment/maven/java-discord-rpc/_latestVersion 3 | [jitpack-version]: https://jitpack.io/v/MinnDevelopment/java-discord-rpc.svg 4 | [jitpack-setup]: https://jitpack.io/#MinnDevelopment/java-discord-rpc 5 | 6 | # NOTICE 7 | 8 | This library is discontinued since the original project [discord-rpc](https://github.com/discord/discord-rpc) is no longer being maintained. Discord now expects you to use the [Game SDK](https://discord.com/developers/docs/game-sdk/sdk-starter-guide) which is not open source and will not be wrapped by this project. More information on the deprecation notice can be found here: [Deprecation and Migration to Discord GameSDK](https://github.com/discord/discord-rpc/issues/290) 9 | 10 | # java-discord-rpc 11 | 12 | [ ![bintray-version][bintray-version] ][bintray-download] [ ![jitpack-version][jitpack-version] ][jitpack-setup] 13 | 14 | This library contains Java bindings for [Discord's official RPC SDK](https://github.com/discord/discord-rpc) using JNA. 15 | 16 | This project provides binaries for `linux-x86-64`, `win32-x86-64`, `win32-x86`, and `darwin`. 17 | The binaries can be found at [MinnDevelopment/discord-rpc-release](https://github.com/MinnDevelopment/discord-rpc-release) 18 | 19 | ## Documentation 20 | 21 | You can see the official discord documentation in the [API Documentation](https://discordapp.com/developers/docs/rich-presence/how-to). 22 |
Alternatively you may visist the javadoc at [jitpack](https://jitpack.io/com/github/MinnDevelopment/java-discord-rpc/master-SNAPSHOT/javadoc/index.html). 23 | 24 | ## Setup 25 | 26 | In the follwing please replace `%VERSION%` with the version listed above. 27 | 28 | Note: Version **2.0.0** and above will be listed on **jcenter**, if you are interested in older builds use **jitpack**. 29 | 30 | ### Gradle 31 | 32 | **Repository** 33 | 34 | ```gradle 35 | repositories { 36 | jcenter() 37 | } 38 | ``` 39 | 40 | **Artifact** 41 | 42 | ```gradle 43 | dependencies { 44 | compile 'club.minnced:java-discord-rpc:%VERSION%' 45 | } 46 | ``` 47 | 48 | ### Maven 49 | 50 | **Repository** 51 | 52 | ```xml 53 | 54 | jcenter 55 | https://jcenter.bintray.com 56 | jcenter-bintray 57 | 58 | ``` 59 | 60 | **Artifact** 61 | 62 | ```xml 63 | 64 | club.minnced 65 | java-discord-rpc 66 | %VERSION% 67 | 68 | ``` 69 | 70 | ### Compile Yourself 71 | 72 | 1. Install git and JDK 8+ 73 | 2. `git clone https://github.com/minndevelopment/java-discord-rpc` 74 | 3. `cd java-discord-rpc` 75 | 4. `./gradlew build` or on windows `gradlew build` 76 | 5. Get the jar from `build/libs` with the name `java-discord-rpc-%VERSION%-all.jar` 77 | 78 | ## Examples 79 | 80 | ### Basics 81 | 82 | The library can be used just like the SDK. This means you can almost copy the exact code used in the official documentation. 83 | 84 | ```java 85 | import club.minnced.discord.rpc.*; 86 | 87 | public class Main { 88 | public static void main(String[] args) { 89 | DiscordRPC lib = DiscordRPC.INSTANCE; 90 | String applicationId = ""; 91 | String steamId = ""; 92 | DiscordEventHandlers handlers = new DiscordEventHandlers(); 93 | handlers.ready = (user) -> System.out.println("Ready!"); 94 | lib.Discord_Initialize(applicationId, handlers, true, steamId); 95 | DiscordRichPresence presence = new DiscordRichPresence(); 96 | presence.startTimestamp = System.currentTimeMillis() / 1000; // epoch second 97 | presence.details = "Testing RPC"; 98 | lib.Discord_UpdatePresence(presence); 99 | // in a worker thread 100 | new Thread(() -> { 101 | while (!Thread.currentThread().isInterrupted()) { 102 | lib.Discord_RunCallbacks(); 103 | try { 104 | Thread.sleep(2000); 105 | } catch (InterruptedException ignored) {} 106 | } 107 | }, "RPC-Callback-Handler").start(); 108 | } 109 | } 110 | ``` 111 | 112 | ### Community Examples 113 | 114 | If you want to add an example to the [example directory](https://github.com/MinnDevelopment/java-discord-rpc/tree/master/examples) 115 | you can do so by making a PR with your package and source. 116 | All I ask from you is that the example does not abuse the API in any way and that your example can compile. 117 | If you would like to add examples in other JVM languages you must first add support via the `build.gradle` file. 118 | 119 | For example, `examples/java/club/minnced/rpc/examples/MyGame.java` would be your example file relative to the project root directory. 120 | 121 | ## License 122 | 123 | java-discord-rpc is licensed under the Apache 2.0 License. The base DiscordRPC is licensed under the MIT license. 124 | 125 | ## Contributing 126 | 127 | Find something that is lacking? Fork the project and pull request! 128 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn ( ) { 37 | echo "$*" 38 | } 39 | 40 | die ( ) { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save ( ) { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /src/main/java/club/minnced/discord/rpc/DiscordRPC.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.discord.rpc; 18 | 19 | import com.sun.jna.Library; 20 | import com.sun.jna.Native; 21 | 22 | import javax.annotation.Nonnull; 23 | import javax.annotation.Nullable; 24 | 25 | /** 26 | * Core library binding for the official Discord RPC SDK. 27 | *
Use {@link #INSTANCE} to access this library. 28 | * 29 | *

Supported Architectures

30 | *
    31 | *
  • Windows x86
    • 32 | *
  • Windows x86-64
    • 33 | *
  • Linux x86-64
    • 34 | *
  • Darwin
    • 35 | *
36 | */ 37 | public interface DiscordRPC extends Library 38 | { 39 | /** 40 | * Library instance. 41 | */ 42 | DiscordRPC INSTANCE = Native.loadLibrary("discord-rpc", DiscordRPC.class); 43 | 44 | /** 45 | * Used to decline a request via {@link #Discord_Respond(String, int)} 46 | * @see #DISCORD_REPLY_YES 47 | */ 48 | int DISCORD_REPLY_NO = 0; 49 | /** 50 | * Used to accept a request via {@link #Discord_Respond(String, int)} 51 | * @see #DISCORD_REPLY_NO 52 | */ 53 | int DISCORD_REPLY_YES = 1; 54 | /** 55 | * Currently unsused response, treated like NO. 56 | * Used with {@link #Discord_Respond(String, int)} 57 | * @see #DISCORD_REPLY_NO 58 | */ 59 | int DISCORD_REPLY_IGNORE = 2; 60 | 61 | /** 62 | * Initializes the library, supply with application details and event handlers. 63 | * Handlers are only called when the {@link #Discord_RunCallbacks()} method is invoked! 64 | *
Before closing the application it is recommended to call {@link #Discord_Shutdown()} 65 | * 66 | * @param applicationId 67 | * The ID for this RPC application, 68 | * retrieved from the developer dashboard 69 | * @param handlers 70 | * Nullable instance of {@link club.minnced.discord.rpc.DiscordEventHandlers} 71 | * @param autoRegister 72 | * {@code true} to automatically call {@link #Discord_RegisterSteamGame(String, String)} or {@link #Discord_Register(String, String)} 73 | * @param steamId 74 | * Possible steam ID of the running game 75 | */ 76 | void Discord_Initialize(@Nonnull String applicationId, 77 | @Nullable DiscordEventHandlers handlers, 78 | boolean autoRegister, 79 | @Nullable String steamId); 80 | 81 | /** 82 | * Shuts the RPC connection down. 83 | * If not currently connected, this does nothing. 84 | */ 85 | void Discord_Shutdown(); 86 | 87 | /** 88 | * Executes the registered handlers for currently queued events. 89 | *
If this is not called the handlers will not receive any events! 90 | * 91 | *

It is recommended to call this in a 2 second interval 92 | */ 93 | void Discord_RunCallbacks(); 94 | 95 | /** 96 | * Polls events from the RPC pipe and pushes the currently queued presence. 97 | *
This will be performed automatically if the attached binary 98 | * has an enabled IO thread (default) 99 | * 100 | *

If the IO-Thread has been enabled this will not be supported! 101 | */ 102 | void Discord_UpdateConnection(); 103 | 104 | /** 105 | * Updates the currently set presence of the logged in user. 106 | *
Note that the client only updates its presence every 15 seconds 107 | * and queues all additional presence updates. 108 | * 109 | * @param struct 110 | * The new presence to use 111 | * 112 | * @see club.minnced.discord.rpc.DiscordRichPresence 113 | */ 114 | void Discord_UpdatePresence(@Nullable DiscordRichPresence struct); 115 | 116 | /** 117 | * Clears the currently set presence. 118 | */ 119 | void Discord_ClearPresence(); 120 | 121 | /** 122 | * Responds to the given user with the specified reply type. 123 | * 124 | *

Possible Replies

125 | *
    126 | *
  • {@link #DISCORD_REPLY_NO}
    • 127 | *
  • {@link #DISCORD_REPLY_YES}
    • 128 | *
  • {@link #DISCORD_REPLY_IGNORE}
    • 129 | *
130 | * 131 | * @param userid 132 | * The id of the user to respond to 133 | * @param reply 134 | * The reply type 135 | * 136 | * @see club.minnced.discord.rpc.DiscordUser#userId DiscordUser.userId 137 | */ 138 | void Discord_Respond(@Nonnull String userid, int reply); 139 | 140 | /** 141 | * Updates the registered event handlers to the provided struct. 142 | * 143 | * @param handlers 144 | * The handlers to update to, or null 145 | */ 146 | void Discord_UpdateHandlers(@Nullable DiscordEventHandlers handlers); 147 | 148 | /** 149 | * Registers the given application so it can be run by the discord client. {@code discord-://} 150 | * 151 | * @param applicationId 152 | * The ID of the application to register 153 | * @param command 154 | * The command for the application startup, or {@code null} to use the 155 | * current executable's path 156 | */ 157 | void Discord_Register(String applicationId, String command); 158 | 159 | /** 160 | * Similar to {@link #Discord_Register(String, String)} but uses the steam 161 | * game's installation path. 162 | * 163 | * @param applicationId 164 | * The ID of the application to register 165 | * @param steamId 166 | * The steam ID for the game 167 | */ 168 | void Discord_RegisterSteamGame(String applicationId, String steamId); 169 | } 170 | -------------------------------------------------------------------------------- /src/main/java/club/minnced/discord/rpc/DiscordRichPresence.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 - 2019 Florian Spieß and the java-discord-rpc contributors 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.discord.rpc; 18 | 19 | import com.sun.jna.Structure; 20 | 21 | import java.util.Arrays; 22 | import java.util.Collections; 23 | import java.util.List; 24 | import java.util.Objects; 25 | 26 | /* 27 | typedef struct DiscordRichPresence { 28 | const char* state; // max 128 bytes 29 | const char* details; // max 128 bytes 30 | int64_t startTimestamp; 31 | int64_t endTimestamp; 32 | const char* largeImageKey; // max 32 bytes 33 | const char* largeImageText; // max 128 bytes 34 | const char* smallImageKey; // max 32 bytes 35 | const char* smallImageText; // max 128 bytes 36 | const char* partyId; // max 128 bytes 37 | int partySize; 38 | int partyMax; 39 | const char* matchSecret; // max 128 bytes 40 | const char* joinSecret; // max 128 bytes 41 | const char* spectateSecret; // max 128 bytes 42 | int8_t instance; 43 | } DiscordRichPresence; 44 | */ 45 | 46 | /** 47 | * Struct binding for a RichPresence 48 | */ 49 | public class DiscordRichPresence extends Structure 50 | { 51 | private static final List FIELD_ORDER = Collections.unmodifiableList(Arrays.asList( 52 | "state", 53 | "details", 54 | "startTimestamp", 55 | "endTimestamp", 56 | "largeImageKey", 57 | "largeImageText", 58 | "smallImageKey", 59 | "smallImageText", 60 | "partyId", 61 | "partySize", 62 | "partyMax", 63 | "matchSecret", 64 | "joinSecret", 65 | "spectateSecret", 66 | "instance" 67 | )); 68 | 69 | public DiscordRichPresence(String encoding) { 70 | super(); 71 | setStringEncoding(encoding); 72 | } 73 | 74 | public DiscordRichPresence() { 75 | this("UTF-8"); 76 | } 77 | 78 | /** 79 | * The user's current party status. 80 | *
Example: "Looking to Play", "Playing Solo", "In a Group" 81 | * 82 | *

Maximum: 128 characters 83 | */ 84 | public String state; 85 | 86 | /** 87 | * What the player is currently doing. 88 | *
Example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP" 89 | * 90 | *

Maximum: 128 characters 91 | */ 92 | public String details; 93 | 94 | /** 95 | * Unix timestamp (seconds) for the start of the game. 96 | *
Example: 1507665886 97 | */ 98 | public long startTimestamp; 99 | 100 | /** 101 | * Unix timestamp (seconds) for the start of the game. 102 | *
Example: 1507665886 103 | */ 104 | public long endTimestamp; 105 | 106 | /** 107 | * Name of the uploaded image for the large profile artwork. 108 | *
Example: "default" 109 | * 110 | *

Maximum: 32 characters 111 | */ 112 | public String largeImageKey; 113 | 114 | /** 115 | * Tooltip for the largeImageKey. 116 | *
Example: "Blade's Edge Arena", "Numbani", "Danger Zone" 117 | * 118 | *

Maximum: 128 characters 119 | */ 120 | public String largeImageText; 121 | 122 | /** 123 | * Name of the uploaded image for the small profile artwork. 124 | *
Example: "rogue" 125 | * 126 | *

Maximum: 32 characters 127 | */ 128 | public String smallImageKey; 129 | 130 | /** 131 | * Tooltip for the smallImageKey. 132 | *
Example: "Rogue - Level 100" 133 | * 134 | *

Maximum: 128 characters 135 | */ 136 | public String smallImageText; 137 | 138 | /** 139 | * ID of the player's party, lobby, or group. 140 | *
Example: "ae488379-351d-4a4f-ad32-2b9b01c91657" 141 | * 142 | *

Maximum: 128 characters 143 | */ 144 | public String partyId; 145 | 146 | /** 147 | * Current size of the player's party, lobby, or group. 148 | *
Example: 1 149 | */ 150 | public int partySize; 151 | 152 | /** 153 | * Maximum size of the player's party, lobby, or group. 154 | *
Example: 5 155 | */ 156 | public int partyMax; 157 | 158 | /** 159 | * Unique hashed string for Spectate and Join. 160 | * Required to enable match interactive buttons in the user's presence. 161 | *
Example: "MmhuZToxMjMxMjM6cWl3amR3MWlqZA==" 162 | * 163 | *

Maximum: 128 characters 164 | */ 165 | public String matchSecret; 166 | 167 | /** 168 | * Unique hashed string for Spectate button. 169 | * This will enable the "Spectate" button on the user's presence if whitelisted. 170 | *
Example: "MTIzNDV8MTIzNDV8MTMyNDU0" 171 | * 172 | *

Maximum: 128 characters 173 | */ 174 | public String joinSecret; 175 | 176 | /** 177 | * Unique hashed string for chat invitations and Ask to Join. 178 | * This will enable the "Ask to Join" button on the user's presence if whitelisted. 179 | *
Example: "MTI4NzM0OjFpMmhuZToxMjMxMjM=" 180 | * 181 | *

Maximum: 128 characters 182 | */ 183 | public String spectateSecret; 184 | 185 | /** 186 | * Marks the matchSecret as a game session with a specific beginning and end. 187 | * Boolean value of 0 or 1. 188 | *
Example: 1 189 | */ 190 | public byte instance; 191 | 192 | @Override 193 | public boolean equals(Object o) 194 | { 195 | if (this == o) 196 | return true; 197 | if (!(o instanceof DiscordRichPresence)) 198 | return false; 199 | DiscordRichPresence presence = (DiscordRichPresence) o; 200 | return startTimestamp == presence.startTimestamp 201 | && endTimestamp == presence.endTimestamp 202 | && partySize == presence.partySize 203 | && partyMax == presence.partyMax 204 | && instance == presence.instance 205 | && Objects.equals(state, presence.state) 206 | && Objects.equals(details, presence.details) 207 | && Objects.equals(largeImageKey, presence.largeImageKey) 208 | && Objects.equals(largeImageText, presence.largeImageText) 209 | && Objects.equals(smallImageKey, presence.smallImageKey) 210 | && Objects.equals(smallImageText, presence.smallImageText) 211 | && Objects.equals(partyId, presence.partyId) 212 | && Objects.equals(matchSecret, presence.matchSecret) 213 | && Objects.equals(joinSecret, presence.joinSecret) 214 | && Objects.equals(spectateSecret, presence.spectateSecret); 215 | } 216 | 217 | @Override 218 | public int hashCode() 219 | { 220 | return Objects.hash(state, details, startTimestamp, endTimestamp, largeImageKey, largeImageText, smallImageKey, 221 | smallImageText, partyId, partySize, partyMax, matchSecret, joinSecret, spectateSecret, instance); 222 | } 223 | 224 | @Override 225 | protected List getFieldOrder() 226 | { 227 | return FIELD_ORDER; 228 | } 229 | } 230 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------