Commit f7a00739 authored by Vildravn's avatar Vildravn
Browse files

Update README.md

parent d67b09d0
# Today in WoW - Widget for Scriptable for iOS
This is a script for [Scriptable](https://scriptable.app) for iOS that parses data from Wowhead's Today in WoW section and displays it on the home screen in a configurable widget.
![Today in WoW Widget screenshot](https://widgets.vildravn.dev/home/tiw.jpeg)
* The widget displays:
* Three current Shadowlands Covenant calling quests
* The two active Torghast wings
* Current weekly Mythic+ affixes
* The current weekly Shadowlands world boss
Today in WoW parses the [Today in WoW section on wowhead.com](https://www.wowhead.com/#tiw-switcher-region) and displays the data as a configurable widget.
All elements can be tapped to open the browser to read more information. Tapping on an empty space on the widget will bring up Wowhead's world quest map.
The widget displays:
* Active/available Shadowlands Covenant calling quests
* Active Torghast wings
* Current weekly Mythic+ affixes
* Current weekly Shadowlands world boss
The individual elements can also be tapped for more information, leading either to a wowhead guide when tapping on the Calling quests and Torghast wings, the wowhead page of the tapped affix or the world boss' loot table. Tapping on an empty space on the widget brings up a map of current world quests for your region.
## Installation
1. Install [Scriptable](https://apps.apple.com/us/app/scriptable/id1405459188?uo=4)
1. Place `Today in WoW.js` and `cheerio.js` in the `Scriptable` folder on your iCloud Drive
1. (Optional) Edit the `Today in WoW.js` script to configure it (See the Configuration section below)
1. Add a Scriptable widget to the home screen and while still in edit mode, tap on the widget to configure it
1. In the widget configuration, select the `Today in WoW` script, the `When interacting` and `Parameter` fields aren't important
1. Tap away from the widget configuration modal
[![Download with ScriptDude](https://scriptdu.de/download.svg)](https://scriptdu.de/?name=Today-in-WoW&source=https%3A%2F%2Fgitlab.com%2Fvildravn%2Ftoday-in-wow-widget%2F-%2Fraw%2Fmaster%2FToday%2520in%2520WoW.js&docs=https%3A%2F%2Fwidgets.vildravn.dev%2F%23tiw#generator)
## Configuration
or
Edit the `Today in WoW.js` script to adjust the configuration of the widget. Currently supports region and faction, and defaults to EU Horde.
Download the script from [GitLab](https://gitlab.com/vildravn/today-in-wow-widget/-/raw/master/Today%20in%20WoW.js) and place it into the Scriptable folder on your iCloud Drive.
## Screenshot
After the script is installed within Scriptable:
1. Add a new Scriptable widget to your Home Screen (**Medium size only, for now**)
1. Tap on the added widget and select **Today in WoW** in the **Script** field. You can leave **When Interacting** as-is.
1. Configure the **Parameter** field:
* Enter your region, the field accepts EU or US (<a href="" target="_blank">click for screenshot</a>)
* If the field is left empty, or is set improperly, the widget will default to displaying EU data
1. Tap away from the Widget configuration modal
1. You may need to wait a bit for iOS to update the widget
![Screenshot of the widget](https://i.imgur.com/eG6qX3q.png)
\ No newline at end of file
[`Changelog`](https://gitlab.com/vildravn/today-in-wow-widget/-/blob/master/CHANGELOG.md)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment