runelite/wiki

wiki's Issues

Camera: update

Among others the new disable screen shake needs to be added runelite/runelite@f1b880a

Bank-tags: add various missing features

Currently the bank tags/bank tag tabs info is missing a couple features, including:

• The tagtabs tab.
• While changing the position of tag tabs, you can use the swap and insert option of the bank to swap or insert tag tabs iirc.
• Tags like the treasure chest tag. Maybe somewhat confusingly they're part of the clue scroll plugin, not the bank tags plugin though iirc. They can be found here: https://github.com/runelite/runelite/blob/bd6d38579e189618ce2ee0b6b8b49368a7d4acd7/runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/ClueScrollPlugin.java#L260-L265
• Bank tag layouts have recently been added to core

Special attack counter: update

Among others a bunch of weapons are missing, including elder maul and potentially the new emberlight when it gets added. Also the defense draining infobox could potentially get added.

Plugin hub Info wiki shows outdated screenshot

Type

Incorrect behavior

Operating System

None

OS Version

No response

Bug description

https://github.com/runelite/runelite/wiki/Information-about-the-Plugin-Hub

The second image is no longer accurate instead the the plugin hub is now the plug icon, instead of the button on the bottom like the old screenshot shows

Screenshots or videos

RuneLite version

N/A.. its a wiki problem

Logs

No response

Update the `Runelite (configure)` image

On the https://github.com/runelite/wiki/blob/cc293617bce1f566425ccb4cd532d32852eddfe8/RuneLite-Launcher-Configuration.md page is an image that shows the Configuration popup, but it uses an image that shows Debug being ✖️'d.

Basically all the time people spend reading that wiki page relates to them needing to enable safe mode, and seeing Debug selected can cause confusion for them. So it should be replaced with an image that has Safe mode selected. (or nothing)

I'd update it myself but I don't have a new launcher version

World Hopper plugin's ::hop command should be documented

The World Hopper plugin allows hopping to a specific world via a chat command ::hop [world-id], but as far as I'm aware, this is not documented anywhere. The wiki section of the plugin should at least mention this.

Document the ability to disable hardware acceleration with `Runelite (configuration)`

In https://github.com/runelite/runelite/wiki/Disable-Hardware-Acceleration - a few methods are listed for disabling Hardware acceleration, but there is not a method to easily disable it with the new Runelite (configuration) shortcut.

This approach should be added.

Many of the links in the Mage Training Arena plugin page are broken.

There are references to settings which don't exist in the current plugin settings like "The plugin also offers the ability to instead of one tile draw the line of tiles on which you are able to stand to correctly cast the spell." or "The plugin also allows you to change from icons to text." or "This overlay will add a counter infobox displaying how many fruit your bones will get you and the color changes depending on whether this is enough for a point.".

I was interested in using these settings but my plugin settings only offer the ability to turn on and off in the various rooms.

Edit: Sorry the link to the wiki page I am referring to is: https://github.com/runelite/runelite/wiki/Mage-Training-Arena

Mage-training-arena: update

Mention the yellow square functionality added in: runelite/runelite@bc6c31a

Maybe also older commits like runelite/runelite@bc1e542 are relevant

GPU plugin docs says requires Windows 7, 8 or 10 But doesn't mention anything about Windows 11.

Type

Other

Operating System

Windows

OS Version

No response

Bug description

The text says GPU plugin docs says requires Windows 7, 8 or 10 But doesn't mention anything about Windows 11.

Screenshots or videos

No response

RuneLite version

n/a

Logs

No response

Add spellbook plugin to sidebar

Right now the page is completely missing from the sidebar.

Document the development issue where the client is see-through

During the setup process to build the client with Intellij, for an unknown reason, running the maven command once will start-up the client, but said client will be see-through, running maven again resolves this issue.

The ability to resolve this issue is technically documented here:

but it doesn't actually indicate it would resolve this issue specifically.

Personally I obviously had this issue when building the client, and only figured out the command would fix it due to me trying the command just because it was there, and it just happened to work perfectly.

Apparently there is an explicit error for this issue, but I had never seen it nor was it in the screenshot posted by a user in the discord with said issue.

Update Rejected feature page permitting use of Twitch emotes

wiki/Rejected-or-Rolled-Back-Features.md

Line 31 in d9b33c3

* Twitch/BTTV/FFZ/7TV emote plugins: Distributing the emotes for these plugins would likely require skirting over the legal agreements of these services, and thus won't be accepted.

In an original PR to add a plugin to support emote images, there was some uncertainty and a brief comment chain about the legality of incorporating external assets which led to inaction¹… and it was never resolved or answered. And so for organizational purposes (?) the PR was closed while awaiting communication. No follow up was ever made on the PR and it stayed pending indefinitely closed. (But not rejected)

Contributors later submitting their own versions of the same feat. are rejected by members who cite the original PR's (legal) uncertainty as their own certain proof that similar PRs could not be merged.

And then this happens five or so more times and everyone seems very very certain about something that was never resolved in the first place.

I'm sure there might have been a resolution but looking over all the issues and PRs, there is no documentation of it. There is not even off-repo discussion referenced anywhere except within the original PR. ¯\_(ツ)_/¯
on the off chance there was not… you'll agree surely that one years-old timed-out PR is objectively not-great justification for giving up on implementing future contributions.

Footnotes

1. (the PR was initially approved and then backtracked before merge due to [some offline discussion]) ↩

misc image issues

follow-up list from #68

cannon didn't get a new gif, the archived one shows the 2018 version of the client so I didn't include it
info panel image has hub plugins, i don't personally care but i'm noting it
notes could maybe use a new image post-flatlaf

images that weren't added to the repo because they randomly started breaking and I don't understand why:

boss-timers Felanbird@3261529 & Felanbird@09221e1
music image Felanbird@772ce20
opponent info
pest control
screen markers
skill calc
world hopper

Update dev tools pictures

https://github.com/runelite/wiki/blob/master/Using-the-client-developer-tools.md should be updated to contain the VM dropdown button, and the text might need a slight update as well.

Document `!kc toa` variations

My only issue trying to document these is they don't seem to follow the existing standard of what examples to use.

e.g. for CoX/ToB the examples use these options, which seem fairly correct to show off
https://github.com/runelite/wiki/blob/master/Chat-Commands.md#L105-L107

• 3 letter shortform toa ✔️
• any case for the name tombs/amascut ❌
• final boss warden ❌
• raid# raids 3 ❌

Only the shortform is actually an applicable option for ToA examples, the others just don't exist for ToA
ChatCommandsPlugin.java#L2191-L2256

Options:

1. Add switch cases to better standardize the ToA options
2. Add whichever examples for ToA and call it a day
3. Add whichever examples for ToA and add a note pointing the user to the switch statements for raids name options

Discussed here: https://discord.com/channels/301497432909414422/442492468307427330/1184898360071700581

Building with IntelliJ IDE guide fails on maven install

Type

Other

Operating System

Windows

OS Version

10

Bug description

When following the guide: https://github.com/runelite/runelite/wiki/Building-with-IntelliJ-IDEA

At this step: https://github.com/runelite/runelite/wiki/Building-with-IntelliJ-IDEA#building-the-project

Tests fail and causes the build to not complete. The fix was to run the install without tests which the guide states:

"Recommended" is not the same as required. A user (myself included) may ignore these erors since they were instructed to do so.

Screenshots or videos

No response

RuneLite version

Runelite Version: 1.10.36-SNAPSHOT
Launcher Version: Unknown

Logs

installlog.txt

This is my install log when running the normal maven install.

Ground items: update

Among others the shift-right click recoloring is missing. Probs note that it's per id and mention easy/med/hard/elite clues.

Chainmace Animation Smoothing glitch

There's a glitch right now where if you have Ursine Chain mace it randomly swings around with animation smoothing on. Even with 117HD off it still does it.

Create border around game for plugins to create less clutter

(runelite/runelite#18061 (comment))
lately, i have been interested in becoming a better pvmer, and i have found out about optimising the client size.

I used to play on 1750x1370 and now have switched to 1500x900 and have enjoyed the switch with one downside. The screen feels so cluttered, but i have a simple solution

A separate option to lock my game size at my desired 1500x900, but then lock my window size at 2070x1275(as in picture) or any size desired. This would create a black border around the game screen. Then allow us to move my plugins off the game window, allowing for a clear field of view but also the plugins to still be visible

At the moment we can make the black border by playing with the game size and interger scaling but this isnt great because then ui isnt scaled to the desired size and the plugin hud isnt able to be dragged into the black border section

This is a quick and dirty mspaint job of what the desired outcome would look like

Chat commands: add lunar chest and alternative names

runelite/runelite@964703a

Ground markers: swap to right-click color marking

Ground markers still contains the old remember color per tile option in the images and text, while the new shift+right-clicking and selecting color is missing in both the text and images.

Chat commands: add missing aliases

Probably move 6 jad challenge above inferno, then put colosseum below inferno.
runelite/runelite@beb29e7

Also check other chat commands commits like runelite/runelite@13e18d5

Opacity

Is there a way to re-add inventory tag opacity?

MES: update

Among others probably add some info regarding the submenu swaps: on what capes is it allowed, not allowed on the other items (for now?), some info on how it works since it can confuse new users.

Add tooltip info regarding HP and additional effects provided by new Varlamore Hunter food

Via the plugin Item Stats

Since it heals in two portions, have it formatted accordingly? Right value is the total the food would heal. As an example for the Cooked Larupia perhaps it could be +6+5/+11 or with a toggle option to ignore the formatting.

For the Cooked Dashed Kebbit, add the additional info of the +10 run energy like how it is for Stamina Potions
+13+10/+23
+10/+10 (100) Run Energy

Improve minimap plugin documentation

The plugin also has options for hiding the minimap and enabling minimap zoom, which are not mentioned anywhere. Maybe the current dots info should also be improved; that's hard to judge right now on mobile.

Config profiles are poorly documented

Currently /profiles from the discord bot links to https://github.com/runelite/runelite/wiki/General-Features#profiles, which is useful for people who had previously used --session and/or --config, but is unhelpful for providing general information about the feature. We should add some basic details about how they work and what each of the buttons do, similar to how is shown in the blog post where it was announced: https://runelite.net/blog/show/2023-02-18-1.9.11-Release

World hopper: update

Potentially update with new commits like chat world filtering.

Outdated

Also, this might be gh mobile just being weird, but why is this on the page:

mlm: update plugin information

The plugin recently got updated in response to the project rebalance changes. Some superfluous overlays got removed or moved (e.g. to the loot tracker).

The current info is outdated and some users in #support are confused because they can't find the overlays anymore.

1440p scaling in modern resizable mode issue

I play 1440p, and I want to scale the UI with 'Stretched Mode' to where on modern resizable the icons for inv, equip, prayer, etc. will stack on top of each other instead of spread out on a flat line on the bottom of the screen. This is possible to do correctly if you open the runelite side panel and set the scaling to 141%. The problem lies when you close the runelite side panel, you then have to set the scaling to 167% to get the icon to stack but at 167% the UI is massive and the inv overlaps into the minimap and the chat becomes very large. I need a way to lock UI at a certain scaling position. That way when I open and close the runelite side panel it doesn't shift my icons. Also, if you could do the for each individual UI section like the chat, minimap, and inventory all have scaling that can be locked to a certain %. This would be amazing and solve all my pains.

Expand macOS install limbo information

While my little blurb about what to do to fix your Jagex Launcher always being stuck on Install on macOS, is correct, it's very clearly missing either images or a GIF to indicate how to do this.

I don't own a mac so someone else has to do it

wiki/FAQ.md

Lines 205 to 206 in 6bef129

	## The Jagex launcher is stuck on Install on macOS
	Unlike on Windows where the Jagex launcher can check where your RuneLite is installed, on macOS it expects RuneLite to be in the applications folder. Moving it to the applications folder will resolve your issue.