search

SMaloney2017 / Temple-OSRS-Plugin

A RuneLite plugin using the TempleOSRS API.
BSD 2-Clause "Simplified" License
3 stars 2 forks source link

readme

TempleOSRS Plugin

A RuneLite plugin utilizing the TempleOSRS API.

demo

Configuration

image

Menu Options

  1. Toggle Autocomplete
  2. Toggle Temple menu-option
  3. Toggle Fetch-defaults

Rank Options

  1. Set default-player to be fetched on startup or search-icon double-click
  2. Set default-range
  3. Toggle auto-update of local-player on logout

Clan Options

  1. Toggle display of clan-achievements
  2. Toggle display of clan-members
  3. Toggle display of current-top player rankings
  4. Set default-range for current-top player rankings
  5. Default clan ID loaded on startup or search-icon double-click
  6. Verification key for clan-sync
  7. Ignore specified ranks during clan-sync
  8. Toggle only add members during clan-sync rather than add/remove

Competition Options

  1. Default competition loaded on startup or search-icon double-click
  2. Competition Watchlist

Frequently Asked Questions

  1. Where can I find my Clan Key?

    • The group's verification-key is used by group-admins to edit a group's leaders, members, and type on TempleOSRS. A group key is generated when a new group is created on TempleOSRS and is usually only accessible to that group's admins . Clan-Sync uses the group-key to update the fetched group's members to those in the local-player's current clan.

  2. Where can I find my Clan or Competition's ID?

    • Clan and Competition IDs are unique identifiers generated on group or competition creation and are used to fetch relevant information. It's possible that there are many groups or competitions with the same name on TempleOSRS, so it's necessary to fetch imformation by ID rather than by name. Clan and Competition IDs can be found in the URL of the clan or competition's TempleOSRS page. These IDs can be set as defaults in the plugin's configuartion afterwards .