beng-07 / trackmania-webhook

Automatically share your new PB on a Discord server.

WebHook

This plugin automatically tracks and shares your Trackmania PB's on Discord via a webhook. It shares your PB in real-time, it simplifies sharing your gaming progress with friends on a common Discord server.

Important!

DO ONLY SHARE YOUR WEBHOOK TOKEN WITH PEOPLE YOU TRUST! ANYONE IN POSESSION OF THE TOKEN CAN SEND ANY MESSAGE THEY WANT OR EVEN DELETE THE WEBHOOK!

Requirements

• Discord Webhook ID
• Discord Webhook Token

Configuration

Discord

• Grant @everyone permission to "Use External Emojis" in the channel of the webhook. (This is used to display the achieved medal)

Trackmania

• Discord Webhook URL: copy the entire webhook URL (e.g.: https://discord.com/api/webhooks/223704706495545344/3d89bb7572e0fb30d8128367b3b1b44fecd1726de135cbe28a41f8b2f777c372ba2939e72279b94526ff5d1bd4358d65cf11) into the "Discord WebHook-URL" field in the settings.

Bug reports

I greatly appreciate user feedback and bug reports for the plugin via my GitHub repository. Please use the issue template on the Trackmania-WebHook issues page to include necessary details like reproduction steps, expected vs. actual behavior, environment details, and screenshots. This ensures a better and faster process. The input is vital for the plugin's improvement and stability, and I'll try to timely respond. Everyones efforts help the enhancment of this plugin for everyone.

Contributing

• Make sure to use the project code styles
• English git commits only
• Branches 🌱 for features are preferred
• Document any additions or changes

Proper Versioning

• big relases/improvements -> from 0.1.12 to 1.0.0
• features -> from 0.1.10 to 0.2.0
• fixes, patches -> from 0.1.0 to 0.1.1

Source code

For those interested in exploring the code of this plugin, the complete source code is hosted on GitHub. You can access it, along with all related documentation and update history, by visiting the repository.

trackmania-webhook's Issues

add in-game username

Currently the plugin tries to ping a discord username (which has to be set up manually) but I would much prefer seeing my TM username in the message instead of getting pinged. From what I can tell, User.Name in the plugin is not actually referenced anywhere outside of the class constructor

allow non-developers to access advanced settings

not sure why this is locked behind dev mode, I feel normal users should be allowed access to this

add delta to previous PB

seeing the amount of improvement is helpful in my opinion

add exports

other plugin developers may like to utilize stuff from this plugin to send their own webhooks

add map thumbnail

not a huge deal but would be nice to have that in the embed

add tmio/tmx links

It would be nice to have links to the trackmania.io and trackmania.exchange (if uploaded) pages in the embedded message. Probably just have settings for them

error when entering editor

plugin probably shouldn't run at all in the editor

[Suggestion]: Message for COTD and qualifying.

Describe your idea/suggestion.

Messages for COTD and Qualifying.
e.g.:
when getting a good placement in qualifying
when achieving a good placement in your division/overall
...

Proposed Solution

A completely new Message-Type for COTD.

Additional context

No response

add map author

probably with link to their trackmania.io page

[Suggestion]: Compare your time with the time of other players before sending a PB-Message

Describe your idea/suggestion.

Compare your time to other club members or players before sending a new PB-Message.

Proposed Solution

A new condition for a PB-Message, that takes beating the times of other players into consideration.

Additional context

No response