Skip to content

A RuneLite plugin that takes in-game chat channels and displays them in separate windows or the side panel.

License

Notifications You must be signed in to change notification settings

Yenof/chat-panel

Repository files navigation

Chat Panel Plugin

This plugin displays in-game chat in a seperate window or the side panel.

The Chat Panel window can be moved freely like a normal windowed application, including to different monitors.

imagefixedimage

Configuration

There are many config groups that contain the plugin's settings.
They can be expanded by clicking on the group name or little arrows.

Screenshot from 2024-06-18 19-56-35 image

Configurable text, background, timestamp, and name colors per tab.

Adjustable Font sizes per tab. (Min size 5, max 200)

Screenshot from 2024-08-21 16-55-26

"Odd Row Shading" tints alternating lines of chat for visability. Negative entries darken, positive lighten.

Line spacing adds space in between messages. (Max 10)

The font can be changed by selecting one of the several example fonts, or with the Custom Font option you can use a .ttf or .otf font file of your choice. (More info in Usage section)

Options for Bold, Italic, Italic Bold, and Plain font styles.

Timestamps can be set using SimpleDateFormat patterns. (HH:mm, yyyy.MM.dd, and more)

Screenshot from 2024-08-21 16-56-05 Screenshot from 2024-08-21 16-56-26

The window size and transparency (opacity) of the pop out window can be configured.

The pop out window can be set to "Always on Top", keeping it on top of other windows and programs.

"Auto-Pop Out Window" allows the pop out window to spawn when RuneLite is started with the plugin on, or when the plugin is turned on.

"Remember Pop Out Position" saves the size and location of the pop out window to be used next time the pop out window is opened.

image Screenshot from 2024-08-21 16-59-57

Can choose between many tabs to display: Public, Private, Clan, Friends Chat, Game, All, Combat, and Custom (1, 2, 3).

For the Combat Tab, there are options to only show combat events related to you, hide zero damage events, and show deaths in chat.

The height of the Chat Area in the side panel can be adjusted, recommended to be less than the height of your client.

The sidebar icon position can be adjusted or the icon hidden.

Can hide the Pop out and Pop in buttons, except when the side panel is empty.

Can disable the icon for the pop out windows.

"Export Log Date" allows you to select a date format for the .txt file created by Export Log.

By using "Enable My Name Color" and "My Name Color" you can set a name color for when a message has your username in the name field.

Chosen words (Separated by commas) can be highlighted with the "Highlight Words" options. "Partial Word Highlighting" allows highlight words like "Sell" to highlight part of "Selling".

Screenshot from 2024-08-21 17-00-19 Screenshot from 2024-08-21 16-58-45

Usage:

Right-clicking on a tab shows additional options like "Pop Out", "Reset History", "Export Log", and "Search".

The right-click "Search" option functions similarly to Ctrl+F; it finds, highlights, and jumps to instances of the search term within the tab.

Clicking a tab with middle mouse button can also pop the tab out into it's own window.

Scroll and click to lock position while reading, return to the bottom to resume snapping to most recent message.

Text can be copied with Ctrl+C.

Custom tabs start empty, and you must add desired chat channels through the Custom Chat configurations.

If you have "Hide Sidebar Icon" enabled and close the pop out window, you will need to toggle the plugin on/off with Auto-Pop enabled to have a new Chat Panel window created.

To use a Custom Font, place a .ttf or .otf file named customfont.ttf into %userprofile%\.runelite\chat-panel on Windows or ~/.runelite/chat-panel on Linux/OSX, then select -Custom Font- in Chat Panel's config.
It must be named exactly customfont.ttf, even if it is an .otf file.
Not all font files work, notably fonts with colors or pictures seem to not work.

Screenshot from 2024-08-21 17-01-28 Screenshot from 2024-09-15 19-18-22

Notes:

Max lines of chat is 10,000 by default.

Some config options apply retroactively when changed, but not all.

When toggling the plugin on/off it does not remember message history (including closing and reopening the client).

Really long NPC Dialog messages get cut off and don't show the whole text, there are other plugins that handle this better.

Combat Tab provides very basic combat logging, there are other plugins for more advanced logging.

The Combat tab relies on what the player is targetting, so if you are hit and you have no target it will just say "PlayerName was hit for: 1".

The appearance of Chat Panel's titlebar is mostly dependent on your operating system's settings, some systems allow user customization of titlebars.
For now, Chat Panel does not inherit RuneLite's Custom Chrome on all OSs, some work though.
Screenshots are taken on X11/GNOME/22.04 with RuneLite's Custom Chrome enabled.




I love feedback, please feel free to reach out with any comments, concerns, or questions to @Yenofthunder on Discord. :D
or
Issues can be posted to Github Issues.
Suggestions can be posted to Github Discussions.

About

A RuneLite plugin that takes in-game chat channels and displays them in separate windows or the side panel.

Resources

License

Stars

Watchers

Forks

Languages