commit eff53837a305dbb2a26a63db302ebdcbccf5fd54 Author: idylls Date: Fri Dec 16 15:46:20 2022 -0500 Render tick tock overlay near mouse diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1b6985c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..4824b18 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,56 @@ +import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar + +plugins { + kotlin("jvm") version "1.7.21" + id("com.github.johnrengelman.shadow") version "7.1.0" +} + +repositories { + mavenCentral() + mavenLocal() + maven { + url = uri("https://repo.runelite.net") + } +} + +val runeLiteVersion = "latest.release" + +dependencies { + compileOnly(group = "net.runelite", name = "client", version = runeLiteVersion) + + compileOnly("javax.inject:javax.inject:1") + compileOnly("org.projectlombok:lombok:1.18.20") + annotationProcessor("org.projectlombok:lombok:1.18.20") +} + +tasks { + named("shadowJar") { + exclude("module-info.class") + exclude("META-INF/") + exclude("*META-INF*") + exclude("META-INF*") + exclude("*META-INF") + exclude("META-INF") + } +} + +tasks { + build { + dependsOn(shadowJar) + } +} + +tasks { + compileKotlin { + kotlinOptions { + jvmTarget = "1.8" + freeCompilerArgs = listOf("-Xjvm-default=all") + } + } + compileTestKotlin { + kotlinOptions { + jvmTarget = "1.8" + freeCompilerArgs = listOf("-Xjvm-default=all") + } + } +} diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..a69d9cb --- /dev/null +++ b/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..53a6b23 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/runelite-plugin.properties b/runelite-plugin.properties new file mode 100644 index 0000000..d704051 --- /dev/null +++ b/runelite-plugin.properties @@ -0,0 +1,5 @@ +displayName=Tickle +author=Idylls +description=Tick Tracking Utilities +tags=tick,ticks +plugins=net.idylls.TickleKt diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..9a71819 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,10 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/7.5.1/userguide/multi_project_builds.html + */ + +rootProject.name = "tickle" diff --git a/src/main/kotlin/net/idylls/tickle/Overlay.kt b/src/main/kotlin/net/idylls/tickle/Overlay.kt new file mode 100644 index 0000000..bce2611 --- /dev/null +++ b/src/main/kotlin/net/idylls/tickle/Overlay.kt @@ -0,0 +1,58 @@ +package net.idylls.tickle + +import org.slf4j.LoggerFactory + +import java.awt.Graphics2D +import java.awt.Dimension +import java.awt.Rectangle +import java.awt.Color +import java.awt.BasicStroke + +import javax.inject.Inject + +import net.runelite.api.Client +import net.runelite.client.ui.overlay.OverlayLayer +import net.runelite.client.ui.overlay.OverlayPosition +import net.runelite.client.ui.overlay.OverlayPriority +import net.runelite.client.ui.overlay.OverlayUtil +import net.runelite.api.Point + +class Overlay +@Inject constructor( + val client: Client, + val plugin: TicklePlugin, +): net.runelite.client.ui.overlay.Overlay() { + val log = LoggerFactory.getLogger(TicklePlugin::class.java) + + init { + this.position = OverlayPosition.DYNAMIC + this.layer = OverlayLayer.ALWAYS_ON_TOP + this.priority = OverlayPriority.MED + } + + override public fun render(gfx: Graphics2D): Dimension? { + val mousePos = client.getMouseCanvasPosition() + val mousePos_ = Point(mousePos.getX() + 10, mousePos.getY() + 10) + + renderTickTock(gfx, mousePos_) + + return null + } + + fun renderTickTock(gfx: Graphics2D, mousePos: Point) { + val color = when (plugin.ticksSinceLogin % 2) { + 0 -> Color(255, 0, 0) + else -> Color(0, 255, 0) + } + + val shape = Rectangle(mousePos.getX(), mousePos.getY(), 10, 10) + + OverlayUtil.renderPolygon( + gfx, + shape, + null, + color, + BasicStroke(0.0f), + ) + } +} diff --git a/src/main/kotlin/net/idylls/tickle/Panel.kt b/src/main/kotlin/net/idylls/tickle/Panel.kt new file mode 100644 index 0000000..84cc834 --- /dev/null +++ b/src/main/kotlin/net/idylls/tickle/Panel.kt @@ -0,0 +1,40 @@ +package net.idylls.tickle + +import org.slf4j.LoggerFactory + +import java.awt.GridBagLayout +import java.awt.BorderLayout +import java.awt.event.ActionEvent +import java.awt.event.FocusEvent +import java.awt.event.FocusListener +import java.awt.Color + +import javax.swing.AbstractAction +import javax.swing.BorderFactory +import javax.swing.JPanel +import javax.swing.JTextArea +import javax.swing.KeyStroke +import javax.swing.border.EmptyBorder +import javax.swing.text.BadLocationException +import javax.swing.text.Document +import javax.swing.undo.CannotUndoException +import javax.swing.undo.UndoManager + +import net.runelite.client.ui.ColorScheme +import net.runelite.client.ui.PluginPanel + +class Panel : PluginPanel() { + val log = LoggerFactory.getLogger(Panel::class.java) + + init { + this.setLayout(BorderLayout()) + this.setBorder(BorderFactory.createEmptyBorder(10, 10, 0, 10)) + this.setBackground(ColorScheme.DARK_GRAY_COLOR) + + this.log.info("Initialized Tickle panel") + + val panel = JPanel() + + this.add(panel) + } +} diff --git a/src/main/kotlin/net/idylls/tickle/TicklePlugin.kt b/src/main/kotlin/net/idylls/tickle/TicklePlugin.kt new file mode 100644 index 0000000..0a4904d --- /dev/null +++ b/src/main/kotlin/net/idylls/tickle/TicklePlugin.kt @@ -0,0 +1,70 @@ +package net.idylls.tickle + +import org.slf4j.LoggerFactory + +import com.google.inject.Provides +import javax.inject.Inject + +import net.runelite.api.Client +import net.runelite.client.plugins.Plugin +import net.runelite.client.plugins.PluginDescriptor +import net.runelite.client.config.ConfigManager +import net.runelite.client.ui.overlay.OverlayManager +import net.runelite.client.ui.ClientToolbar +import net.runelite.client.ui.NavigationButton +import net.runelite.client.eventbus.Subscribe +import net.runelite.api.events.GameTick; +import net.runelite.client.util.ImageUtil + +@PluginDescriptor( + name = "Tickle" +) +public class TicklePlugin : Plugin() { + val log = LoggerFactory.getLogger(TicklePlugin::class.java) + + @Inject + lateinit var clientToolbar: ClientToolbar + + @Inject + lateinit var client: Client + + @Inject + lateinit final var overlayManager: OverlayManager + + @Inject + lateinit var panel: Panel + + @Inject + lateinit var overlay: Overlay + + lateinit var navButton: NavigationButton; + + var ticksSinceLogin: Int = 0 + + override fun startUp() { + log.info("Tickle started") + + val icon = ImageUtil.loadImageResource(this::class.java, "icon_temp.png"); + + this.navButton = NavigationButton.builder() + .tooltip("Tickle") + .icon(icon) + .priority(8) + .panel(panel) + .build() + + this.clientToolbar.addNavigation(this.navButton) + + this.overlayManager.add(this.overlay) + } + + override fun shutDown() { + this.clientToolbar.removeNavigation(this.navButton) + this.overlayManager.remove(this.overlay) + } + + @Subscribe + fun onGameTick(tick: GameTick) { + ticksSinceLogin++ + } +} diff --git a/src/main/resources/net/idylls/tickle/icon_temp.png b/src/main/resources/net/idylls/tickle/icon_temp.png new file mode 100644 index 0000000..ed7ee84 Binary files /dev/null and b/src/main/resources/net/idylls/tickle/icon_temp.png differ