├── settings.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src └── main │ ├── java │ └── com │ │ └── github │ │ └── twitch4j │ │ └── chatbot │ │ ├── Launcher.java │ │ ├── features │ │ ├── ChannelNotificationOnFollow.java │ │ ├── WriteChannelChatToConsole.java │ │ ├── ChannelNotificationOnLive.java │ │ └── ChannelNotificationOnSubscription.java │ │ ├── Configuration.java │ │ └── Bot.java │ └── resources │ ├── logback.xml │ └── config.yaml.example ├── README.md ├── .gitignore ├── LICENSE ├── gradlew.bat └── gradlew /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'twitch4j-chatbot' 2 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/twitch4j/twitch4j-chatbot/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/Launcher.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot; 2 | 3 | public class Launcher { 4 | public static void main(String[] args) { 5 | Bot bot = new Bot(); 6 | bot.registerFeatures(); 7 | bot.start(); 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionSha256Sum=a4b4158601f8636cdeeab09bd76afb640030bb5b144aafe261a5e8af027dc612 4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip 5 | networkTimeout=10000 6 | validateDistributionUrl=true 7 | zipStoreBase=GRADLE_USER_HOME 8 | zipStorePath=wrapper/dists 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Twitch4J - Chatbot Template 2 | 3 | Support: 4 | 5 | [![Discord](https://img.shields.io/badge/Join-Twitch4J-7289DA.svg?style=flat-square)](https://discord.gg/FQ5vgW3) 6 | [](https://discord.gg/FQ5vgW3) 7 | 8 | -------- 9 | 10 | ## A quick note: 11 | This Chatbot is part of the [Twitch4J API](https://github.com/PhilippHeuer/twitch4j) project. 12 | 13 | ## Chat Token 14 | You can generate a oauth chat token using the `Twitch Chat OAuth Password Generator`: 15 | http://twitchapps.com/tmi/ 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Java class files 2 | *.class 3 | 4 | # Mobile Tools for Java (J2ME) 5 | .mtj.tmp/ 6 | 7 | # Package Files # 8 | *.jar 9 | *.war 10 | *.ear 11 | 12 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 13 | hs_err_pid* 14 | 15 | # generated files 16 | bin/ 17 | gen/ 18 | build/ 19 | out/ 20 | 21 | # Eclipse project files 22 | .classpath 23 | .project 24 | .settings/ 25 | 26 | # Proguard folder generated by Eclipse 27 | proguard/ 28 | 29 | # Local configuration file (sdk path, etc) 30 | local.properties 31 | 32 | # Intellij project files 33 | *.iml 34 | *.ipr 35 | *.iws 36 | .idea/ 37 | 38 | #Gradle 39 | .gradletasknamecache 40 | .gradle/ 41 | 42 | # Exceptions 43 | !gradle/wrapper/*.jar 44 | 45 | # Config files 46 | *.yaml 47 | 48 | # Logs / Save Files 49 | config/* 50 | client.log 51 | 52 | # Visual Studio Code 53 | .vscode/ 54 | -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/features/ChannelNotificationOnFollow.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot.features; 2 | 3 | import com.github.philippheuer.events4j.simple.SimpleEventHandler; 4 | import com.github.twitch4j.chat.events.channel.FollowEvent; 5 | 6 | public class ChannelNotificationOnFollow { 7 | 8 | /** 9 | * Register events of this class with the EventManager/EventHandler 10 | * 11 | * @param eventHandler SimpleEventHandler 12 | */ 13 | public ChannelNotificationOnFollow(SimpleEventHandler eventHandler) { 14 | eventHandler.onEvent(FollowEvent.class, event -> onFollow(event)); 15 | } 16 | 17 | /** 18 | * Subscribe to the Follow Event 19 | */ 20 | public void onFollow(FollowEvent event) { 21 | String message = String.format( 22 | "%s is now following %s!", 23 | event.getUser().getName(), 24 | event.getChannel().getName() 25 | ); 26 | 27 | event.getTwitchChat().sendMessage(event.getChannel().getName(), message); 28 | } 29 | 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/features/WriteChannelChatToConsole.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot.features; 2 | 3 | import com.github.philippheuer.events4j.simple.SimpleEventHandler; 4 | import com.github.twitch4j.chat.events.channel.ChannelMessageEvent; 5 | 6 | public class WriteChannelChatToConsole { 7 | 8 | /** 9 | * Register events of this class with the EventManager/EventHandler 10 | * 11 | * @param eventHandler SimpleEventHandler 12 | */ 13 | public WriteChannelChatToConsole(SimpleEventHandler eventHandler) { 14 | eventHandler.onEvent(ChannelMessageEvent.class, event -> onChannelMessage(event)); 15 | } 16 | 17 | /** 18 | * Subscribe to the ChannelMessage Event and write the output to the console 19 | */ 20 | public void onChannelMessage(ChannelMessageEvent event) { 21 | System.out.printf( 22 | "Channel [%s] - User[%s] - Message [%s]%n", 23 | event.getChannel().getName(), 24 | event.getUser().getName(), 25 | event.getMessage() 26 | ); 27 | } 28 | 29 | } 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Philipp Heuer 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/features/ChannelNotificationOnLive.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot.features; 2 | 3 | import com.github.philippheuer.events4j.simple.SimpleEventHandler; 4 | import com.github.twitch4j.chatbot.Bot; 5 | import com.github.twitch4j.events.ChannelGoLiveEvent; 6 | 7 | public class ChannelNotificationOnLive { 8 | 9 | private final Bot bot; 10 | 11 | /** 12 | * Register events of this class with the EventManager/EventHandler 13 | * 14 | * @param bot the bot instance 15 | * @param eventHandler SimpleEventHandler 16 | */ 17 | public ChannelNotificationOnLive(Bot bot, SimpleEventHandler eventHandler) { 18 | this.bot = bot; 19 | eventHandler.onEvent(ChannelGoLiveEvent.class, this::onGoLive); 20 | } 21 | 22 | /** 23 | * Subscribe to the Follow Event 24 | */ 25 | public void onGoLive(ChannelGoLiveEvent event) { 26 | String message = String.format( 27 | "%s is now live!", 28 | event.getChannel().getName() 29 | ); 30 | 31 | bot.getTwitchClient().getChat().sendMessage(event.getChannel().getName(), message); 32 | } 33 | 34 | } 35 | -------------------------------------------------------------------------------- /src/main/resources/logback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | %d{HH:mm:ss.SSS} [%thread] %highlight([%-5level]) %logger{25} - %msg%n 11 | 12 | 13 | 14 | 15 | 16 | 17 | %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 18 | 19 | client.log 20 | 21 | client.%i.log 22 | 23 | 24 | 10MB 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/features/ChannelNotificationOnSubscription.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot.features; 2 | 3 | import com.github.philippheuer.events4j.simple.SimpleEventHandler; 4 | import com.github.twitch4j.chat.events.channel.SubscriptionEvent; 5 | 6 | public class ChannelNotificationOnSubscription { 7 | 8 | /** 9 | * Register events of this class with the EventManager/EventHandler 10 | * 11 | * @param eventHandler SimpleEventHandler 12 | */ 13 | public ChannelNotificationOnSubscription(SimpleEventHandler eventHandler) { 14 | eventHandler.onEvent(SubscriptionEvent.class, event -> onSubscription(event)); 15 | } 16 | 17 | /** 18 | * Subscribe to the Subscription Event 19 | */ 20 | public void onSubscription(SubscriptionEvent event) { 21 | String message = ""; 22 | 23 | // New Subscription 24 | if (event.getMonths() <= 1) { 25 | message = String.format( 26 | "%s has subscribed to %s!", 27 | event.getUser().getName(), 28 | event.getChannel().getName() 29 | ); 30 | } 31 | // Resubscription 32 | if (event.getMonths() > 1) { 33 | message = String.format( 34 | "%s has subscribed to %s in his %s month!", 35 | event.getUser().getName(), 36 | event.getChannel().getName(), 37 | event.getMonths() 38 | ); 39 | } 40 | 41 | // Send Message 42 | event.getTwitchChat().sendMessage(event.getChannel().getName(), message); 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/Configuration.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot; 2 | 3 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 4 | import com.fasterxml.jackson.databind.PropertyNamingStrategy; 5 | import com.fasterxml.jackson.databind.annotation.JsonNaming; 6 | 7 | import java.util.List; 8 | import java.util.Map; 9 | 10 | @JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class) 11 | @JsonIgnoreProperties(ignoreUnknown = true) 12 | public class Configuration { 13 | 14 | private Boolean debug; 15 | 16 | private Map bot; 17 | 18 | private Map api; 19 | 20 | private Map credentials; 21 | 22 | private List channels; 23 | 24 | public Boolean getDebug() { 25 | return debug; 26 | } 27 | 28 | public void setDebug(Boolean debug) { 29 | this.debug = debug; 30 | } 31 | 32 | public Map getBot() { 33 | return bot; 34 | } 35 | 36 | public void setBot(Map bot) { 37 | this.bot = bot; 38 | } 39 | 40 | public Map getApi() { 41 | return api; 42 | } 43 | 44 | public void setApi(Map api) { 45 | this.api = api; 46 | } 47 | 48 | public Map getCredentials() { 49 | return credentials; 50 | } 51 | 52 | public void setCredentials(Map credentials) { 53 | this.credentials = credentials; 54 | } 55 | 56 | public List getChannels() { 57 | return channels; 58 | } 59 | 60 | public void setChannels(List channels) { 61 | this.channels = channels; 62 | } 63 | 64 | @Override 65 | public String toString() { 66 | return "Configuration{" + 67 | "bot=" + bot + 68 | ", api=" + api + 69 | ", credentials=" + credentials + 70 | ", channels=" + channels + 71 | '}'; 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /src/main/resources/config.yaml.example: -------------------------------------------------------------------------------- 1 | ######################################################################################## 2 | # # 3 | # _____ _ _ _ ___ ___ _____ _ _ _ _ # 4 | # |_ _| (_) | | | / | |_ | / __ \ | | | | | | | # 5 | # | |_ ___| |_ ___| |__ / /| | | | | / \/ |__ __ _| |_| |__ ___ | |_ # 6 | # | \ \ /\ / / | __/ __| '_ \/ /_| | | | | | | '_ \ / _` | __| '_ \ / _ \| __| # 7 | # | |\ V V /| | || (__| | | \___ |/\__/ / | \__/\ | | | (_| | |_| |_) | (_) | |_ # 8 | # \_/ \_/\_/ |_|\__\___|_| |_| |_/\____/ \____/_| |_|\__,_|\__|_.__/ \___/ \__| # 9 | # # 10 | # # 11 | # This is an example configuration file for a Twitch4J Chatbot. # 12 | # Please read and change all options to suit your setup. # 13 | # Then rename the file to config.yaml # 14 | # # 15 | ######################################################################################## 16 | 17 | debug: false 18 | bot: 19 | # Name of your bot 20 | name: "twitch4j chatbot" 21 | 22 | # Current version of your bot 23 | version: "0.1" 24 | 25 | # Application - API Settings 26 | api: 27 | # Twitch Application Client Id 28 | twitch_client_id: YOUR_CLIENT_ID 29 | 30 | # Twitch Application Client Secret 31 | twitch_client_secret: YOUR_CLIENT_SECRET 32 | 33 | # Credentials 34 | credentials: 35 | # OAuth Token for IRC USer (You can get yours here: http://twitchapps.com/tmi/) 36 | irc: YOUR_IRC_TOKEN 37 | 38 | # Channels - The bot will connect to all listed channels 39 | channels: 40 | - YOUR_CHANNEL -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 1>&2 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 48 | echo. 1>&2 49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 50 | echo location of your Java installation. 1>&2 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 1>&2 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 62 | echo. 1>&2 63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 64 | echo location of your Java installation. 1>&2 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /src/main/java/com/github/twitch4j/chatbot/Bot.java: -------------------------------------------------------------------------------- 1 | package com.github.twitch4j.chatbot; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; 5 | import com.github.philippheuer.credentialmanager.domain.OAuth2Credential; 6 | import com.github.twitch4j.ITwitchClient; 7 | import com.github.twitch4j.TwitchClientBuilder; 8 | import com.github.philippheuer.events4j.simple.SimpleEventHandler; 9 | 10 | import com.github.twitch4j.chatbot.features.ChannelNotificationOnFollow; 11 | import com.github.twitch4j.chatbot.features.ChannelNotificationOnLive; 12 | import com.github.twitch4j.chatbot.features.ChannelNotificationOnSubscription; 13 | import com.github.twitch4j.chatbot.features.WriteChannelChatToConsole; 14 | 15 | import java.io.InputStream; 16 | 17 | public class Bot { 18 | 19 | /** 20 | * Holds the Bot Configuration 21 | */ 22 | private Configuration configuration; 23 | 24 | /** 25 | * Twitch4J API 26 | */ 27 | private ITwitchClient twitchClient; 28 | 29 | /** 30 | * Constructor 31 | */ 32 | public Bot() { 33 | // Load Configuration 34 | loadConfiguration(); 35 | 36 | TwitchClientBuilder clientBuilder = TwitchClientBuilder.builder(); 37 | 38 | //region Auth 39 | OAuth2Credential credential = new OAuth2Credential( 40 | "twitch", 41 | configuration.getCredentials().get("irc") 42 | ); 43 | //endregion 44 | 45 | //region TwitchClient 46 | twitchClient = clientBuilder 47 | .withClientId(configuration.getApi().get("twitch_client_id")) 48 | .withClientSecret(configuration.getApi().get("twitch_client_secret")) 49 | .withEnableHelix(true) 50 | /* 51 | * Chat Module 52 | * Joins irc and triggers all chat based events (viewer join/leave/sub/bits/gifted subs/...) 53 | */ 54 | .withChatAccount(credential) 55 | .withEnableChat(true) 56 | /* 57 | * Build the TwitchClient Instance 58 | */ 59 | .build(); 60 | //endregion 61 | } 62 | 63 | /** 64 | * Method to register all features 65 | */ 66 | public void registerFeatures() { 67 | SimpleEventHandler eventHandler = twitchClient.getEventManager().getEventHandler(SimpleEventHandler.class); 68 | 69 | // Register Event-based features 70 | ChannelNotificationOnLive channelNotificationOnLive = new ChannelNotificationOnLive(this, eventHandler); 71 | ChannelNotificationOnFollow channelNotificationOnFollow = new ChannelNotificationOnFollow(eventHandler); 72 | ChannelNotificationOnSubscription channelNotificationOnSubscription = new ChannelNotificationOnSubscription(eventHandler); 73 | WriteChannelChatToConsole writeChannelChatToConsole = new WriteChannelChatToConsole(eventHandler); 74 | } 75 | 76 | /** 77 | * Load the Configuration 78 | */ 79 | private void loadConfiguration() { 80 | try { 81 | ClassLoader classloader = Thread.currentThread().getContextClassLoader(); 82 | InputStream is = classloader.getResourceAsStream("config.yaml"); 83 | 84 | ObjectMapper mapper = new ObjectMapper(new YAMLFactory()); 85 | configuration = mapper.readValue(is, Configuration.class); 86 | } catch (Exception ex) { 87 | ex.printStackTrace(); 88 | System.out.println("Unable to load Configuration ... Exiting."); 89 | System.exit(1); 90 | } 91 | } 92 | 93 | public void start() { 94 | // Connect to all channels 95 | for (String channel : configuration.getChannels()) { 96 | twitchClient.getChat().joinChannel(channel); 97 | } 98 | 99 | // Enable client helper for Stream GoLive / GoOffline / GameChange / TitleChange Events 100 | twitchClient.getClientHelper().enableStreamEventListener(configuration.getChannels()); 101 | // Enable client helper for Follow Event 102 | twitchClient.getClientHelper().enableFollowEventListener(configuration.getChannels()); 103 | } 104 | 105 | public ITwitchClient getTwitchClient() { 106 | return twitchClient; 107 | } 108 | } 109 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | --------------------------------------------------------------------------------