Skip to content

General-Features.md

Latest commit

 

History

History
104 lines (65 loc) · 4.9 KB

General-Features.md

File metadata and controls

104 lines (65 loc) · 4.9 KB
Raw

General RuneLite features

The RuneLite settings can be found as a plugin. See RuneLite for more information about the various settings the client has to offer.

RuneLite incorporates functions such as:

  • Moving overlays
  • Hiding the sidebar
  • Custom Cursor/Font/Sound/Login Screen
  • Notification Customization
  • Profiles

Moving overlays

It's possible to move overlays and infoboxes by holding the Alt key and dragging them to a desired position. Whilst dragging blue squares will show fixed positions where they can be locked in.

You can reset an overlay's size and position by holding the Alt key and right-clicking the overlay.

Hiding the sidebar

It's possible to hide the sidebar by pressing the left arrow next to the minimize button. To show the sidebar again press the right arrow. This can also be done using the shortcut keys ctrl+F11.

Custom Cursor/Font/Sound/Login Screen

Place the files for the feature you want in %userprofile%\.runelite on Windows or ~/.runelite/ on Linux/OSX The names and type for the files are:

  • Custom cursor: cursor.png
  • Custom font: <font_name>.ttf file in .runelite/fonts
  • Custom default notification sound: notification.wav
  • Custom specific notification sound: <name>.wav in .runelite/notifications, then select <name> in the notification sound dropdown
  • Custom login screen: login.png Image size 765 x 503 recommended, larger images will be (simply) scaled down automatically.

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.

  • Native: Use default system notification sound
  • Custom: The custom notification sound can be placed in %userprofile%\.runelite on Windows or ~/.runelite/ on Linux/MacOS. The notification must be called notification.wav and be in .wav format.

Additional custom notification sounds can be placed in the associated .runelite/notifications/ directory. These sounds must be in .wav format and will appear in the dropdown as the name of the sound file.

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

Send the notification even when the client is focused.

Profiles

Profiles are separate sets of plugins and settings that can be switched between at any time. They can be managed under a tab in the configuration panel.

Clicking the arrow to the right of a profile will expand it to reveal the buttons used to interact with the profile. From left to right, the buttons are:

  1. Rename profile
  2. Duplicate profile
  3. Export profile
  4. Set profile as default for the current RuneScape account
    • Must be logged in to the game using a RuneScape account
  5. Enable cloud sync
    • Must be logged in to the client using a RuneLite.net account
  6. Delete profile

Clicking the arrow to the right of the profile while it is already expanded will activate the profile. You can also double-click a profile to activate it. Profiles can be re-ordered by dragging them. Toggleable buttons will turn orange to indicate they are enabled. The currently activated profile is indicated by the orange bar highlight on its left.

By default the profile loaded on startup will be the one that was most recently active. To load a specific profile on startup you can pass --profile=<profilename> to the launcher.

Advanced users that previously utilized the old method of passing a --session and/or --config parameter should now instead use --profile. An import feature was included to facilitate taking all the distinct settings created by those and creating profiles from them, simply select to import and navigate to the directory containing the settings and select them individually.

More info on the importing procedure can be found in [[this FAQ entry | FAQ#how-do-i-convert-the-previous-multi-sessionsetting-file-to-a-profile]]