Skip to content

Commit

Permalink
Update Idle Notifier documentation (#142)
Browse files Browse the repository at this point in the history
* Add documentation for overrides

* Document the new additions to the Idle Notifier config

* Remove numbers in the Idle Notifier headers

* Reword Notification sound to explain how to use a custom sound
  • Loading branch information
pajlada authored Jan 29, 2025
1 parent 4285e0a commit 8267191
Showing 1 changed file with 95 additions and 11 deletions.
106 changes: 95 additions & 11 deletions Idle-Notifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,122 @@ Sends a notification when going idle, or when your hp/prayer reaches a certain t

## Settings

### 1. Idle Animation Notification
### Idle Animation Notification

Toggles notifying you when stopping skilling animations such as mining, fletching, or creating battlestaves.

### 2. Idle Interaction Notifications
### Idle Interaction Notifications

Toggles notifying you when you stop interacting with an NPC which includes combat and fishing.

### 3. Idle Movement Notifications
### Idle Movement Notifications

Toggles notifying you when your character stops moving and stays idle there

### 4. Idle Logout Notifications
### Idle Logout Notifications

Toggled notifying you when you don't interact with the client for too long.

### 5. Idle Notification Delay
### Idle Notification Delay

Choose how long your animation or interaction has to be stopped before sending a notification. Don't set it too low as some animations have long delays.

### 6. Hitpoints Notification Threshold
### Six hour logout notification

Choose hp threshold to send a notification. NOTICE! By default you will only get notifications when the client is out of focus, to change this see RuneLite.
Toggled notifying you when you're about to be logged out due to being online for too long.

### 7. Prayer Notification Threshold
### Hitpoints Notification

Toggled notifying you when your hitpoints hits the **Hitpoints Notification Threshold**.

NOTICE! By default you will only get notifications when the client is out of focus, to change this see RuneLite settings or customize this notification by clicking the cogwheel next to the checkbox. See further down the page for those settings.

### Hitpoints Notification Threshold

Choose hp threshold to send a notification.

### Prayer Notification

Toggled notifying you when your prayer hits the **Prayer Notification Threshold**.

### Prayer Notification Threshold

Choose prayer threshold to send a notification.

### 8. Oxygen Notification Threshold
### Low Energy Notification

Toggled notifying you when your run energy hits the **Low Energy Notification Threshold**.

### Low Energy Notification Threshold

The amount of run energy remaining to send a notification at.

### High Energy Notification

Toggled notifying you when your run energy hits the **High Energy Notification Threshold**.

### High Energy Notification Threshold

The amount of run energy reached to send a notification at.

### Oxygen Notification

Toggled notifying you when your oxygen (during underwater activities) hits the **Oxygen Notification Threshold**.

### Oxygen Notification Threshold

Choose oxygen threshold (during underwater activities) below which to send a notification.

### 9. Special Attack Energy Notification Threshold
### Special Attack Energy Notification

Toggled notifying you when your special attack percentage hits the **Special Attack Energy Notification Threshold**.

### Special Attack Energy Notification Threshold

Choose special attack percentage regeneration threshold at which send a notification.

## Notification Customization

After enabling one of the notifications, a cogwheel will appear next to the checkbox where you can check **Customize notification**, allowing you to customize how the specific notification will show up.

### Tray notification

Enables tray notifications.

### Request focus

Configures the window focus request type on notification.

- **Request**: Requests user attention. Brings window to the front (Windows); Bounces RuneLite dock icon (MacOS).
- **Taskbar**: Flash the taskbar.
- **Force**: Forces window to the front.

### Notification sound

Determines what sound to use for system notifications triggered by RuneLite.

You can select **Native** to use the default system notification sound, or place a custom notification sound (must be in .wav format) in `%userprofile%\.runelite` on Windows or `~/.runelite/` on Linux/MacOS and it will be available in this list.

### Notification volume

Configures the volume of custom notifications (does not control native volume).

### Notification timeout

How long notifications will be shown in milliseconds. A value of 0 will make it use the system configuration. (Linux only)

### Game message notification

Adds a notification message to the chatbox.

### Flash

Flashes the game frame as a notification.

### Flash color

The color of the notification flashes.

### Send notifications when focused

Choose special attack percentage regeneration threshold at which send a notification.
Send the notification even when the client is focused.

0 comments on commit 8267191

Please sign in to comment.