Skip to content

420kc/clan-clog

Repository files navigation

Clan Clog

Clan Clog is a RuneLite plugin. The clan-scale sibling to Kill Clog.

product

Search a clan name. See a Clan Clog Profile: a shared PvM trophy case where the collection log is the union of every member's public drops.

Clan Clog is a clan identity surface, not a leaderboard. The goal is to make a clan's collection log readable, shareable, and proof-backed through roster syncs, public hiscores, TempleOSRS, RuneProfile, and item-level proof when available.

status

Alpha. Active development on master. Public Plugin Hub submission gated on the killclog.com aggregation backend reaching production capacity.

current capabilities

  • reads the user's in-game clan roster via the modern OSRS Clan API (ClanSettings)
  • listens for clan chat broadcasts (joined / left / kicked) and parses them in real time
  • narrates clan events in the local chatbox as Clogsworth, the clan butler (formal, dry, occasionally devastating); narration is local-only, never broadcast to clan chat
  • ports the foundational data layer from Kill Clog: hiscore fetch, account-type detection, per-player disk cache

target v1 capabilities

  • sync your clan to killclog.com once via a key-rank-gated handshake; roster stays current passively as members open the clan list in-game
  • render a Kill Clog-style profile for the clan with the combined collection log across all members
  • surface a clan badge on each member's individual Kill Clog Profile automatically once the clan is synced

data

Clan Clog reads from and (opt-in) writes to external services:

  • killclog.com — primary public clan-profile reads and, when Enable Sync is turned on (off by default) and you hold a key clan rank, verified roster syncs.
  • Jagex hiscores (secure.runescape.com), TempleOSRS, RuneProfile, and Wise Old Man (api.wiseoldman.net) — public data sources used by the Clan Clog ecosystem for hiscores, collection-log data, and roster discovery.
  • Syncing transmits the clan roster (RSNs + ranks) so killclog.com can build or refresh the profile at killclog.com/c/<slug>. Clogsworth's clan-event narration stays local and is never transmitted.

project truth

Architecture notes, current provider ownership, sync rules, and release gates live in PROJECT_TRUTH.md.

development

./gradlew compileJava   # build
./gradlew run           # boot RuneLite with the plugin loaded (test classpath)

ecosystem

license

BSD 2-Clause. See LICENSE.

About

Clan Clog, kill clog for clans. RuneLite plugin, clan-scale sibling to Kill Clog.

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages