TrackmaniaTournamentTracker/packages/bridge-shared/trackmania.io-f/README.md

<div align="center">

[![Logo](https://raw.githubusercontent.com/GreepTheSheep/node-trackmania.io/main/docs/graphic/image.svg)](https://tmio.greep.fr/#)

[![NPM](https://nodei.co/npm/trackmania.io.png?downloads=true&stars=true)](https://npmjs.org/trackmania.io)

[![npm](https://img.shields.io/npm/v/trackmania.io?logo=npm)](https://npmjs.com/trackmania.io)
[![GitHub release](https://img.shields.io/github/v/release/GreepTheSheep/node-trackmania.io?logo=github)](https://github.com/GreepTheSheep/node-trackmania.io/releases/latest)

[![Trackmania.io API Status](https://img.shields.io/website?down_message=Offline&label=Trackmania.io%20API&up_message=Online&url=https%3A%2F%2Ftrackmania.io)](https://trackmania.io)
[![Discord](https://img.shields.io/discord/570024448371982373?label=Discord&logo=discord)](https://greep.fr/discord)

[![npm](https://img.shields.io/npm/dw/trackmania.io?logo=npm)](https://npmjs.com/trackmania.io)
[![NPM](https://img.shields.io/npm/l/trackmania.io)](LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/GreepTheSheep/node-trackmania.io?logo=github)](https://github.com/GreepTheSheep/node-trackmania.io/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/GreepTheSheep/node-trackmania.io?logo=github)](https://github.com/GreepTheSheep/node-trackmania.io/pulls)

[![GitHub Repo stars](https://img.shields.io/github/stars/GreepTheSheep/node-trackmania.io?logo=github&style=flat-square)](https://github.com/GreepTheSheep/node-trackmania.io/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/GreepTheSheep/node-trackmania.io?style=flat-square)](https://github.com/GreepTheSheep/node-trackmania.io/network/members)

[![Builds](https://github.com/GreepTheSheep/node-trackmania.io/actions/workflows/build.yml/badge.svg)](https://github.com/GreepTheSheep/node-trackmania.io/actions/workflows/build.yml)

</div>

## Disclaimer - [Can I use the Trackmania.io API for my own project?](https://openplanet.nl/tmio/api)

[Please read this topic](https://openplanet.nl/tmio/api)

*The User Agent Header will be automatically set to your project directory name, with your current file name included, you can also set your User Agent with the method `Client.setUserAgent("My Project Name");`*

API Keys can be set with the method `Client.setAPIKey("yourname:yourkey");`

If you're still unsure about your use of the API, feel free to DM Miss on the [Openplanet Discord](https://openplanet.nl/link/discord) with any further questions.

---
## API Keys

API keys for trackmania.io are not mandatory, but can be used to increase the rate limit. These are not given out frequently, and as such are issued only on request. For more information, contact Miss on the [Openplanet Discord](https://openplanet.nl/link/discord).

---
## Documentation

Documentation and examples are available on [this website](https://tmio.greep.fr/#/docs)

---
## Contributing

Please see the [CONTRIBUTING.md file](CONTRIBUTING.md)

---
## Discussion

If you want to talk about this project or just for saying hi, Join the [Project's Discord Server](https://greep.fr/discord), in the #node-tmio channel

---
## Projects that use this Trackmania.io library

- [discord-trackmania.io](https://github.com/GreepTheSheep/discord-trackmania.io) by [@GreepTheSheep](https://github.com/GreepTheSheep)
- [state-trackmania-bot](https://github.com/allanjacob/state-trackmania-bot) by [@allanjacob](https://github.com/allanjacob)

Add yours here by opening a PR!

---
## Other Trackmania.io Implementations

There are a few other implementations of the Trackmania.io API, these are:

- Python: [py-tmio](https://github.com/NottCurious/py-tmio) by [@NottCurious](https://github.com/NottCurious)
- C# (.NET): [TrackmaniaIo.ApiClient](https://github.com/snixtho/TrackmaniaIo.ApiClient) by [@snixtho](https://github.com/snixtho)

Add yours here by opening a PR!

---
## Thanks

Thanks to [@codecat](https://github.com/codecat) for creating trackmania.io and for helping me with their API *(and updating it everytime)*.

Thanks to Nadeo (Trackmania's studio) for giving an API to trackmania.io.

Thanks to [@dassschaf](https://github.com/dassschaf) and [@stefan-baumann](https://github.com/stefan-baumann) for chat formatting remover code in regex *(it saves my life)*

Thanks to [@Flirno](https://github.com/Flirno) for player COTD results API

Thanks to [@jonese1234](https://github.com/jonese1234) for the dataset to get the players searching

---
<div align="center">

![Alt](https://repobeats.axiom.co/api/embed/6d1745e4fe894ffc1e84f68bc7eb0731588eeda4.svg "Repobeats analytics image")

</div>