BenjyC / clan-events

Used for clan events

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Installation

To install this plugin, go to the plugin hub and search for "Clan Events" or "Elysium" and click install on the first plugin. The overlay will work as long as you modify the password. To get the clan hub panel to show, you must include the Google Sheet ID and Google Sheet API key provided by your clan:

Clan Events

A plugin helpful for clan events. It creates an overlay that displays the event password and time (UTC) to your screen. This plugin can utilize Google Sheets API to retrieve data from Google Spreadsheets.

The plugin will retrieve data from the spreadsheet provided and print out the first two columns as a side panel on runelite:

Home Panel:

image image

Skill of the Week:

image image

Boss of the Week:

image image

Create your own Google spreadsheet and API Key

The spreadsheat must be set to public and the sheet tab names must be one or more of the following: home, sotw, botw, event, hof.

Example spreadsheet:

https://docs.google.com/spreadsheets/d/1YMcXxSL3s1NEzsPVMMkPn7EdGNFKENiwqNyDKkJTO80/

Make sure the sheet is public, otherwise the plugin will not be able to read the Google Sheet: image

The Participant list of BoTW and SoTW on the spreadsheet is directly grabbed from https://templeosrs.com.

The Google Sheet ID and API must be placed in the config in order for the plugin panel to work. You can simply grab the Google Sheet ID from the url of the spreadsheet:

image

Google API Key

Before you create your API Key, you must first login to your Google account and enable the Google Sheet API from the developers console found here: https://console.developers.google.com/apis/library/sheets.googleapis.com

Once you enable the API, you can create your own API Key from here: https://console.developers.google.com/apis/credentials.

Note: There is a limit of 300 requests per minute for your API Key (or 60 requests per minute for an individual). If you ever run into a limit, its best to have multiple API Keys for your usage.

If you are using this plugin for your clan, you can simply share your spreadsheet ID and API Key with the rest of your clan members (I suggest you don't create it with your personal email).

About

Used for clan events

License:BSD 2-Clause "Simplified" License


Languages

Language:Java 100.0%