Update mod.json

README.md

@@ -1,7 +1,20 @@
-# fvnkhead.killstat
+# What is Tone API?
 
-To use, you MUST set `Tone_token` and `Tone_ID` convars
+Tone is an API that allows everyone to view their ingame stats for Northstar.
 
-For now, DM @Legonzaur#2100 to get those informations
+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           |
 
-Alternatively, you can selfhost your own backend [here](https://github.com/Legonzaur/ToneAPI_backend)
+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`
+
+DM @Legonzaur#2100 to get a token

mod.json

@@ -1,7 +1,7 @@
 {
     "Name": "fvnkhead.killstat",
     "Description": "Gather kill statistics and sends them to Tone API server.",
-    "Version": "3.0.1",
+    "Version": "3.0.2",
     "LoadPriority": 1,
     "RequiredOnClient": false,
     "ConVars": [
@@ -15,7 +15,7 @@
         },
         {
             "Name": "Tone_token",
-            "DefaultValue": "pasteyourtokenhere"
+            "DefaultValue": "CHECK_NORTHSTAR_WIKI_INSTRUCTIONS_ABOUT_CONVARS"
         },
         {
             "Name": "killstat_custom_parameters",

mod/scripts/vscripts/killstat.nut

@@ -12,6 +12,7 @@ struct {
     string servername
     string Tone_token
     bool connected
+    //remove this in the future
     array<Parameter> customParameters
 
     int matchId
@@ -23,7 +24,6 @@ void function killstat_Init() {
     file.killstatVersion = GetConVarString("killstat_version")
     file.Tone_URI = GetConVarString("Tone_URI")
     file.Tone_token = GetConVarString("Tone_token")
-    file.Tone_token = "ZjlmZGM0YmEtZjI1Mi00MTNjLTg5MDEtNzI3NzZkNjE2YzRj"
     file.connected = false
     file.servername = GetConVarString("ns_server_name")
     //register to Tone API if default or invalid token
@@ -84,7 +84,7 @@ void function killstat_Record(entity victim, entity attacker, var damageInfo) {
             return
 
     table values = {}
-
+    //remove this in the future
     foreach (Parameter p in file.customParameters) {
         values[p] <- p.value
     }