Logs chat messages to a file in runelite's folder
Documentation
Chat Logger
This plugin allows logging chat messages from different channels to individual files. Currently, the plugin supports public, group, game, private and clan channels and each can be toggled on/off individually.
The log file rotation happens on a daily basis and up to 30 log files are kept. However, this can be changed from the plugin's settings.
The logs can be found at RuneLite's home folder under the chatlogs directory. To find runelite's home navigate to %userprofile%\.runelite on Windows or $HOME/.runelite on Linux and macOS.
Directory structure
The plugin uses the following directory structure:
``
.runelite/
└── chatlogs/
├── friends/
├── private/
├── public/
├── group/
├── game/
└── clan/
`
Note that the friends folder contains the clan chat logs and the private folder contains private messages from friends.
Remote Submission
This plugins allows you to configure submission of your clan chat messages to a remote endpoint. To enable it the user must configure an endpoint and tick the box on the plugin's configuration.
#### Submitted payload & behavior
#### Behavior
The plugin submits chat messages every 5 seconds, multiple chat entries can be submitted at once up to a max of 30 entries.
It also uses a circuit breaker to avoid making requests to a non-functional endpoint.
The circuit breaker opens if more than 3 requests fail within 30 seconds and will switch to half-open after 5 minutes.
It is also worth nothing that multiple clients may submit the same message, deduplication should be done server side!
#### Payload structure
The plugin uses the following structure to submit messages:
`json
[
{
"id": 1417339442575,
"timestamp": "2021-01-01T00:00:00.000000000Z",
"chatType": "FRIENDS",
"chatName": "player name",
"sender": "player name",
"rank": -1,
"message": "Dasdasd"
}
]
`
| field | description |
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| id | A message identifier that can be used to de-dupe incoming messages from multiple sources |
| timestamp | An ISO-8601 compatible UTC timestamp of when the message was received by the client |
| chatType | The type of the chat that the message was sent in, possible values FRIENDS or CLAN (includes guest clan) |
| chatName | The name of the chat that the message was sent in |
| sender | The player that sent the message |
| rank | The ordinal representation of the sender's rank. (see Clan Rank and Friends Chat Rank) |
| message | The message |
The plugin will also always submit an Authorization header, the value none will be submitted if nothing is configured by the user.
This header should be used for user authentication.
Updates
V1.8.1
- Fixed incorrect folder mapping for game log output.
##### V1.8
- Fix compatibility with the latest client changes. The behaviour of the rank
field might change with this update.
##### V1.6
- Fixes private logs containing clan messages
##### V1.5
- Friends/Clan rank added to remote submission
##### V1.4
- Clan chat system support
- Remote submission of clan chat messages
- Added from/to to private message logs
##### V1.2
- Added remote submission of friends chat messages
##### V1.1
- The storage directory has been changed from clanchatlogs
tochatlogs - The plugin is now capable of logging public & private chat channels. Each chat channel has its own directory inside the chatlogs` directory
- Each individual chat channel logging can be toggled on/off
Similar Plugins
A plugin that adds icons to the chatbox based on which Bingo team you're in!
Hides certain Clog messages in CC
Hide clan name and more to clean your chat channels, includes GIM, friends, and clan chats
Add custom emoji and animated GIFs to your chat!