update Readme

This commit is contained in:
2023-04-26 16:58:03 +02:00
parent c7a1cfc41a
commit 2f0c3effb4
+17 -4
View File
@@ -1,7 +1,20 @@
# fvnkhead.killstat # What is Tone API?
Tone is an API that allows everyone to view their ingame stats for Northstar.
The following projects allows users to visualize the API data
|Client |Platform | | | |
|----------------------------------------------------------------------------|----------------------|---|---|---|
|[ToneAPI_webclient](https://github.com/ToneAPI/ToneAPI_webclient) |Webapp | | | |
|[Pulse](https://github.com/ToneAPI/pulse) |Northstar Client mod | | | |
|[Sonar](https://github.com/ToneAPI/Sonar) |Discord bot | | | |
Documentation for the API can be found here : https://github.com/Legonzaur/ToneAPI_backend
# What is this mod ?
This mod is a serverside mod.
When a player makes a kill, it sends the data to the API
To use, you MUST set `Tone_token` To use, you MUST set `Tone_token`
For now, DM @Legonzaur#2100 to get those informations DM @Legonzaur#2100 to get a token
Alternatively, you can selfhost your own backend [here](https://github.com/Legonzaur/ToneAPI_backend)