Oops... looks like the spiders padded through here
Add products to your cart and remove them from here Lets buy📝 Logger
On this page, you will find information on how to log what your players do to a file and to Discord.
This module is configured in modules/logger.yml inside the PhoenixLobby folder.
#Logger
The logger writes down what happens on your lobby. Every event is written to logs/latest.log and can be sent to Discord at the same time.
Every event starts turned off, so nothing is written until you enable the ones you want. Each has its own message, webhook and embed, so joins can go to one channel and chat to another.
#File Logging
The log file and the webhooks are separate switches. Turning file-logging off keeps every webhook posting while nothing is written to disk, which is what a server that only wants its events in Discord needs.
enabled: true
file-logging:
enabled: true
The enabled above it turns the whole module off, file and webhooks together.
#Events
| Event | Logged when |
|---|---|
| player-join | A player joins the lobby |
| player-leave | A player disconnects, not when they change server |
| player-switch-server | A player is sent to another server of the proxy |
| player-anti-vpn | A player is denied by the anti vpn |
| player-anti-wdl | A player tries to use a world downloader |
| player-pvp-join | A player enters pvp mode |
| player-pvp-leave | A player leaves pvp mode |
| server-anti-botting | The anti bot starts a lockdown |
| player-anti-swear | A message is blocked or censored by the chat filter |
| player-command-execution | A player runs a command |
| player-chat-message | A player sends a message |
#Message
The message of an event is written in log-format. It is the line that goes to the log file, and it is also what %message% gives you inside the webhook.
Every event has its own placeholders.
| Event | Placeholders |
|---|---|
| player-join | %player%, %uuid%, %address%, %world%, %online% |
| player-leave | %player%, %uuid%, %address%, %world%, %online% |
| player-switch-server | %player%, %uuid%, %server%, %world% |
| player-anti-vpn | %player%, %uuid%, %address% |
| player-anti-wdl | %player%, %uuid%, %world% |
| player-pvp-join | %player%, %uuid%, %world% |
| player-pvp-leave | %player%, %uuid%, %world% |
| server-anti-botting | %attempts%, %seconds%, %lockdown_seconds% |
| player-anti-swear | %player%, %uuid%, %world%, %message_content%, %action% |
| player-command-execution | %player%, %uuid%, %world%, %command% |
| player-chat-message | %player%, %uuid%, %world%, %message_content% |
%online% leaves vanished staff out, and on a leave it has already dropped the player who left.
%action% returns blocked or censored. On the chat filter event %message_content% is what the player typed, before it was censored.
#Webhook
Paste the address of your Discord webhook in url and that event starts posting. An empty url means nothing is sent, so you only fill in the events you care about.
username and avatar-url change how the bot shows up, and content is a plain message sent above the embed.
The embed is yours to shape with a title, a description, a colour, a footer, a thumbnail, an image and as many fields as you want. The placeholders of the event work in all of them.
The other events follow the same shape, each one with its own message, colour and fields.
Telling a disconnect apart from a server change is done by the proxy, so player-switch-server needs PhoenixLobby installed on the proxy as well. Without it, a player changing server is logged as a leave.