kolief/solace

Purpose and Runtime Entry Points

Solace is a Java/Gradle desktop client built atop a pinned RuneLite version, providing automation-oriented APIs, an SDK, bundled plugins, and loadable external PF4J plugins. Production starts from client/loader/src/main/java/net/solace/loader/SolaceLauncher.java (packaged as a fat JAR); development uses SolaceLoaderDev.java. SolaceInitializer.java wires client services during RuneLite startup.

Module Boundaries

The public automation contract is api/src/main/java/net/solace/api/Solace.java, with interfaces for game state, entities, items, movement, widgets, interaction, events, and plugins. Concrete RuneLite-backed implementations live separately in client/bindings/src/main/java/net/solace/impl/, rooted by ApiModule.java. This interface/implementation boundary isolates scripts and plugins from RuneLite internals and version-specific reflection.

Client Bootstrap and Service Composition

The loader initializes shared state and dependency modules, then integrates interaction, external-plugin, UI, and event facilities:

• client/loader/src/main/java/net/solace/loader/SolaceLoader.java

• client/loader/src/main/java/net/solace/loader/modules/LoaderModule.java

• client/loader/src/main/java/net/solace/loader/modules/InteractionModule.java

• client/loader/src/main/java/net/solace/loader/events/EventManager.java

Control flow is launcher → loader/initializer → dependency injection/modules → RuneLite client and plugin managers. Shared local directories and loader state are represented in common/src/main/java/net/solace/loader/Directories.java and SolaceManager.java.

Game Observation and Automation

Bindings wrap RuneLite actors, tiles, items, widgets, and game state, while API providers and queries expose filtered script-facing views. Representative paths:

• api/src/main/java/net/solace/api/query/Query.java

• api/src/main/java/net/solace/api/interact/Automation.java

• client/bindings/src/main/java/net/solace/impl/domain/game/ClientImpl.java

An interaction request is built for an actor/item/tile/widget, queued through the loader interaction manager, executed as automated menu/mouse activity, and surfaced through pre/post automation events. Mouse execution is configurable via MouseManager.java and movement strategies under api/.../interact/mouse/.

Movement and World Data

Movement combines local collision, global collision maps, teleports, and transports to produce walking behavior:

• client/bindings/src/main/java/net/solace/impl/movement/pathfinder/Pathfinder.java

• client/bindings/src/main/java/net/solace/impl/movement/WalkerManager.java

• api/src/main/java/net/solace/api/movement/pathfinder/GlobalCollisionMap.java

Offline cache tooling generates collision-map data from the RuneScape cache in data/cache-tools/src/main/java/net/solace/rscache/map/MapGenerator.java; generated artifacts are consumed by the data/collision-maps module. Teleport/transport decisions are constrained by item, quest, skill, variable, and charge requirements.

Plugin Ecosystem and UI

Built-in automation plugins are compiled in plugins/bundled, using looped/task plugin abstractions from api/.../plugins; loader-side managers schedule and isolate their execution:

• client/loader/src/main/java/net/solace/loader/plugins/PluginManagerImpl.java

• client/loader/src/main/java/net/solace/loader/plugins/DefaultLoopedPluginExecutor.java

• plugins/bundled/src/main/java/net/solace/loader/plugins/fighter/SolaceFighterPlugin.java

External JARs from ~/.solace/plugins/ are discovered and loaded through PF4J-based SDN support in plugins/hub/src/main/java/net/solace/sdn/pf4j/SdnPf4jPluginManager.java. Swing-based configuration, profile, plugin-list, loadout, and external-plugin panels are provided by the ui module, notably ui/src/main/java/net/solace/ui/module/UiModule.java.

SDK and Version-Mapping Infrastructure

SDK offers ergonomic static façades over API services for third-party script authors, e.g. sdk/src/main/java/net/solace/sdk/game/Client.java and sdk/src/main/java/net/solace/sdk/movement/Walker.java. RuneLite updates require canonical/version mappings, generated and applied through mappings/generator/.../MappingGenerator.java and mappings/tool/.../GenerateVersionPackage.java; these mappings are a critical compatibility boundary between Solace bindings and obfuscated RuneLite code.