commit 67bc2a485731a1f9b20a350b55d778a5e2b88009 Author: idylls Date: Thu Dec 15 12:27:32 2022 -0500 Initial version, basic pathfinding diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..097f9f9 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + 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..6971425 --- /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 = "1.9.6-SNAPSHOT" + +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/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ae04661 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists 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..f127cfd --- /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..fe7bdc5 --- /dev/null +++ b/runelite-plugin.properties @@ -0,0 +1,5 @@ +displayName=Pathos +author=Idylls +description=Pathing helper +tags=pathing,path +plugins=net.idylls.PathosKt diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..e34d0c3 --- /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 = "pathos" diff --git a/src/main/kotlin/net/idylls/pathos/Overlay.kt b/src/main/kotlin/net/idylls/pathos/Overlay.kt new file mode 100644 index 0000000..38e2dfb --- /dev/null +++ b/src/main/kotlin/net/idylls/pathos/Overlay.kt @@ -0,0 +1,388 @@ +package net.idylls.pathos + +import java.awt.Graphics2D +import java.awt.Dimension +import java.awt.Color +import java.awt.BasicStroke +import javax.inject.Inject + +import net.runelite.api.Client +import net.runelite.api.Perspective +import net.runelite.api.Point + +import net.runelite.client.ui.overlay.Overlay +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.coords.LocalPoint +import net.runelite.api.CollisionDataFlag +import net.runelite.api.Tile + +import kotlin.math.abs + +/** + * Draws an overlay based on the Old School RuneScape pathfinding + * algorithm. More information can be found here: + * https://oldschool.runescape.wiki/w/Pathfinding + */ + +const val SCENE_WIDTH = 128 +const val SCENE_BUF_LEN = SCENE_WIDTH * SCENE_WIDTH + +typealias ScenePoint = Point +typealias CollisionFlags = Int + +fun buildPath( + backEdges: Map, + _current: ScenePoint +): Sequence { + var current = _current + + return generateSequence({ + val ret = current + current = when (val next = backEdges.get(current)) { + null -> return@generateSequence null + else -> next + } + + return@generateSequence ret + }) +} + +fun findPath( + from: ScenePoint, + to: ScenePoint, + collisionFlags: Array, + tiles: Array>, +): Sequence? { + + // A basic breadth-first search, taking into account OSRS movement + // rules + + val seen = mutableSetOf(from) + val queue = ArrayDeque() + queue.add(from) + + val backEdges = mutableMapOf() + + while (!queue.isEmpty()) { + val current = queue.removeFirst() + + if (current == to) { + return buildPath(backEdges, current) + } + + val unvisitedNeighbors = neighbors( + current, + { sp -> + if ( + (sp.getX() < 0) + || (sp.getY() < 0) + || (sp.getX() >= SCENE_WIDTH) + || (sp.getY() >= SCENE_WIDTH) + ) { + return@neighbors null + } + + if (tiles[sp.getX()][sp.getY()] == null) { + return@neighbors null + } + + return@neighbors collisionFlags[sp.getX()][sp.getY()] + }, + ).filter({ n -> !seen.contains(n) }) + + for (n in unvisitedNeighbors) { + backEdges.put(n, current) + queue.add(n) + seen.add(n) + } + } + + return null +} + +fun sceneX(t: Tile) = t.sceneLocation.x +fun sceneY(t: Tile) = t.sceneLocation.y + +fun sceneCoords(t: Tile) = ScenePoint(t.sceneLocation.getX(), t.sceneLocation.getY()) + +fun canMoveCardinal( + from: CollisionFlags, + to: CollisionFlags, + direction: Direction, +): Boolean { + if ((to and ( + CollisionDataFlag.BLOCK_MOVEMENT_FULL + or CollisionDataFlag.BLOCK_MOVEMENT_OBJECT + )) > 0) { + return false + } + + if ((from and direction.collisionFlag) > 0) { + return false + } + + return true +} + +/** + * the adjDir params should be the direction to move from the adjacent + * tile into the diagonal tile. e.g. If you are trying to move south-west + * and adj1 params the southern tile, adjDir1 should be west (because you + * move south, then west) + */ +fun canMoveDiagonal( + from: CollisionFlags, + to: CollisionFlags, + direction: Direction, + adjOk1: Boolean, + adjFlags1: CollisionFlags, + adjDir1: Direction, + adjOk2: Boolean, + adjFlags2: CollisionFlags, + adjDir2: Direction, +): Boolean { + return ( + adjOk1 + and adjOk2 + and canMoveCardinal(adjFlags1, to, adjDir1) + and canMoveCardinal(adjFlags2, to, adjDir2) + and canMoveCardinal(from, to, direction) + ) +} + +enum class Direction( + val dx: Int, + val dy: Int, + val collisionFlag: CollisionFlags, +) { + WEST(-1, 0, CollisionDataFlag.BLOCK_MOVEMENT_WEST), + EAST(1, 0, CollisionDataFlag.BLOCK_MOVEMENT_EAST), + SOUTH(0, -1, CollisionDataFlag.BLOCK_MOVEMENT_SOUTH), + NORTH(0, 1, CollisionDataFlag.BLOCK_MOVEMENT_NORTH), + SOUTH_WEST(-1, -1, CollisionDataFlag.BLOCK_MOVEMENT_SOUTH_WEST), + SOUTH_EAST(1, -1, CollisionDataFlag.BLOCK_MOVEMENT_SOUTH_EAST), + NORTH_WEST(-1, 1, CollisionDataFlag.BLOCK_MOVEMENT_NORTH_WEST), + NORTH_EAST(1, 1, CollisionDataFlag.BLOCK_MOVEMENT_NORTH_EAST), +} + +fun neighbors( + current: ScenePoint, + collisionFlags: (ScenePoint) -> CollisionFlags?, +): Sequence { + val spd = { sp: ScenePoint, d: Direction -> + ScenePoint(sp.getX() + d.dx, sp.getY() + d.dy) + } + + val cf = { d: Direction -> collisionFlags(spd(current, d)) } + + val currentFlags = collisionFlags(current)!! + + data class CanMoveCardinal( + val canMove: Boolean, + val flags: CollisionFlags, + ) + val checkCardinal = c@{ d: Direction -> + val flags = when (val f = cf(d)) { + null -> return@c null + else -> f + } + + return@c CanMoveCardinal( + canMoveCardinal(currentFlags, flags, d), + flags, + ) + } + + val west = checkCardinal(Direction.WEST) + val east = checkCardinal(Direction.EAST) + val south = checkCardinal(Direction.SOUTH) + val north = checkCardinal(Direction.NORTH) + + val checkDiagonal = c@{ + d: Direction, + cmc1: CanMoveCardinal?, + cmc1Dir: Direction, + cmc2: CanMoveCardinal?, + cmc2Dir: Direction, + -> + if (cmc1 == null) { + return@c false + } + + if (cmc2 == null) { + return@c false + } + + val diagonalFlags = when (val f = cf(d)) { + null -> return@c false + else -> f + } + + return@c canMoveDiagonal( + currentFlags, + diagonalFlags, + d, + cmc1.canMove, + cmc1.flags, + cmc1Dir, + cmc2.canMove, + cmc2.flags, + cmc2Dir, + ) + } + + val southWest = checkDiagonal( + Direction.SOUTH_WEST, + south, Direction.WEST, + west, Direction.SOUTH, + ) + val southEast = checkDiagonal( + Direction.SOUTH_EAST, + south, Direction.EAST, + east, Direction.SOUTH, + ) + val northWest = checkDiagonal( + Direction.NORTH_WEST, + north, Direction.WEST, + west, Direction.NORTH, + ) + val northEast = checkDiagonal( + Direction.NORTH_EAST, + north, Direction.EAST, + east, Direction.NORTH, + ) + + val e = { b: Boolean, d: Direction -> + if (b) { spd(current, d) } else { null } + } + return sequenceOf( + e(west?.canMove ?: false, Direction.WEST), + e(east?.canMove ?: false, Direction.EAST), + e(south?.canMove ?: false, Direction.SOUTH), + e(north?.canMove ?: false, Direction.NORTH), + e(southWest, Direction.SOUTH_WEST), + e(southEast, Direction.SOUTH_EAST), + e(northWest, Direction.NORTH_WEST), + e(northEast, Direction.NORTH_EAST), + ).filter({ n -> n != null }).map({ n -> n!! }) +} + +class Overlay +@Inject constructor( + val client: Client, + val config: PathosConfig, +): net.runelite.client.ui.overlay.Overlay() { + init { + this.position = OverlayPosition.DYNAMIC + this.layer = OverlayLayer.ABOVE_SCENE + this.priority = OverlayPriority.MED + } + + override public fun render(gfx: Graphics2D): Dimension? { + val player = client.getLocalPlayer() + if (player == null) { + return null + } + val z = client.plane + + val collisions = client.collisionMaps + if (collisions == null) { + return null + } + + val _playerTrueTile = LocalPoint.fromWorld(client, player.worldLocation) + if (_playerTrueTile == null) { + return null + } + val playerTrueTile = ScenePoint(_playerTrueTile.sceneX, _playerTrueTile.sceneY) + + val planeCollisions = collisions[z] + val collisionFlags = planeCollisions.flags + val tiles = client.scene.tiles[z] + + val _hoveredTile = client.selectedSceneTile + + val hoveredPathTiles = if ( + config.highlightHoveredPath() + && _hoveredTile != null + ) { + val hoveredTile = _hoveredTile.sceneLocation + renderTile(gfx, hoveredTile, Color(0, 0, 255), 1.0) + + when (val p = findPath( + playerTrueTile, + hoveredTile, + collisionFlags, + tiles, + )) { + null -> emptySequence() + else -> p + } + } else { + emptySequence() + } + + val destinationPoint = client.getLocalDestinationLocation() + val destinationPathTiles = if ( + config.highlightDestinationPath() + && destinationPoint != null + ) { + val destinationTile = ScenePoint( + destinationPoint.sceneX, + destinationPoint.sceneY, + ) + when (val p = findPath( + playerTrueTile, + destinationTile, + collisionFlags, + tiles, + )) { + null -> emptySequence() + else -> p + } + } else { + emptySequence() + } + + paintTiles( + gfx, + hoveredPathTiles, + config.highlightHoveredBorder(), + config.highlightHoveredBorderWidth(), + ) + paintTiles( + gfx, + destinationPathTiles, + config.highlightDestinationBorder(), + config.highlightDestinationBorderWidth(), + ) + + return null + } + + fun paintTiles( + gfx: Graphics2D, + tiles: Sequence, + color: Color, + borderWidth: Double, + ) { + for (tile in tiles) { + renderTile(gfx, tile, color, borderWidth) + } + } + + fun renderTile( + gfx: Graphics2D, + tile: ScenePoint, + borderColor: Color, + borderWidth: Double, + ) { + var local = LocalPoint.fromScene(tile.getX(), tile.getY()) + var poly = Perspective.getCanvasTilePoly(client, local) + + OverlayUtil.renderPolygon(gfx, poly, borderColor, Color(0, 0, 0, 0), BasicStroke(borderWidth.toFloat())) + } +} diff --git a/src/main/kotlin/net/idylls/pathos/PathosConfig.kt b/src/main/kotlin/net/idylls/pathos/PathosConfig.kt new file mode 100644 index 0000000..59337f2 --- /dev/null +++ b/src/main/kotlin/net/idylls/pathos/PathosConfig.kt @@ -0,0 +1,91 @@ +package net.idylls.pathos + +import java.awt.Color + +import net.runelite.client.config.Alpha +import net.runelite.client.config.Config +import net.runelite.client.config.ConfigGroup +import net.runelite.client.config.ConfigItem +import net.runelite.client.config.ConfigSection + +@ConfigGroup("pathos") +public interface PathosConfig : Config { + companion object { + @ConfigSection( + name = "Destination", + description = "Destination Path Configuration", + position = 0, + ) + const val destinationPath = "destinationPath" + + @ConfigSection( + name = "Hovered Path", + description = "Hovered Tile Path Configuration", + position = 1, + ) + const val hoveredPath = "hoveredPath" + + @ConfigSection( + name = "Additional", + description = "Additional Settings", + position = 2, + ) + const val additional = "additional" + } + + @ConfigItem( + keyName = "highlightDestinationPath", + name = "Highlight destination path", + description = "Highlight the tiles along the path to the player's destination", + section = destinationPath, + position = 0, + ) + fun highlightDestinationPath(): Boolean = true + + @Alpha + @ConfigItem( + keyName = "highlightDestinationBorder", + name = "Destination path tiles border color", + description = "Configures the border color of tiles along the path to the player's destination", + section = destinationPath, + position = 1, + ) + fun highlightDestinationBorder(): Color = Color(255, 255, 255, 128) + + @ConfigItem( + keyName = "highlightDestinationBorderWidth", + name = "Destination path tiles border width", + description = "Configures the border width of tiles along the path to the player's destination", + section = destinationPath, + position = 2, + ) + fun highlightDestinationBorderWidth(): Double = 1.0 + + @ConfigItem( + keyName = "highlightHoveredPath", + name = "Highlight hovered path", + description = "Highlight the tiles along the path to the hovered destination", + section = hoveredPath, + position = 0, + ) + fun highlightHoveredPath(): Boolean = true + + @Alpha + @ConfigItem( + keyName = "highlightHoveredBorder", + name = "Hovered path tiles border color", + description = "Configures the border color of tiles along the path to the hovered destination", + section = hoveredPath, + position = 1, + ) + fun highlightHoveredBorder(): Color = Color(255, 255, 255, 128) + + @ConfigItem( + keyName = "highlightHoveredBorderWidth", + name = "Hovered path tiles border width", + description = "Configures the border width of tiles along the path to the hovered destination", + section = hoveredPath, + position = 2, + ) + fun highlightHoveredBorderWidth(): Double = 1.0 +} diff --git a/src/main/kotlin/net/idylls/pathos/PathosPlugin.kt b/src/main/kotlin/net/idylls/pathos/PathosPlugin.kt new file mode 100644 index 0000000..cbeb024 --- /dev/null +++ b/src/main/kotlin/net/idylls/pathos/PathosPlugin.kt @@ -0,0 +1,42 @@ +package net.idylls.pathos + +import com.google.inject.Provides +import javax.inject.Inject +import lombok.extern.slf4j.Slf4j + +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 + +@Slf4j +@PluginDescriptor( + name = "Pathos" +) +public class PathosPlugin : Plugin() { + @Inject + lateinit final var config: PathosConfig + + @Inject + lateinit final var client: Client + + @Inject + lateinit final var overlayManager: OverlayManager + + @Inject + lateinit final var overlay: Overlay + + override fun startUp() { + this.overlayManager.add(this.overlay) + } + + override fun shutDown() { + this.overlayManager.remove(this.overlay) + } + + @Provides + fun provideConfig(cm: ConfigManager): PathosConfig { + return cm.getConfig(PathosConfig::class.java) + } +}