diff --git a/README.md b/README.md index a7b652d..205d48e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -# jscore +# JScore -API per a guardar puntuacions i històries en "la nube" \ No newline at end of file +API per a guardar puntuacions i històries en "la nube" + +## LEADERBOARDS + +### const bool initOnlineScore(std::string game); + Arreplega les puntuacions dels jugadors. Una vegada arreplegades s'accedeix a les dades amb les següents tres funcions: + +### const int getNumUsers(); + Obtindre el nombre de jugadors en la tabla de puntuacions. + +### std::string getUserName(const int index); + Obtindre el nom del jugador en la posició 'index' + +### const int getPoints(const int index); + Obtindre els punts del jugador en la posició 'index' + +### const bool updateUserPoints(std::string game, std::string user, const int points); + Actualitzar la puntuació del usuari 'user' per al joc 'game' + +## DADES GENÈRIQUES + +### void setUserData(std::string game, std::string user, std::string data); + Guarda la cadena arbitraria 'data' per al usuari 'user' en el joc 'game' + +### std::string getUserData(std::string game, std::string user); + Obté la cadena guardada per al usuari 'user' en el joc 'game' + +No es fa ninguna neteja del que s'envía, així que no envies coses rares. Les dades viatgen en el GET. O siga, en la mateixa URL. Res de caràcters raros. Més avant ja vorem si fique una codificació base64 o algo. + +Tampoc he fet massa neteja ni comprobació de errors ni res. Ho solte ja "in the wild" i ja anem arreglant i millorant sobre la marxa. \ No newline at end of file