###About###

• This library allows mods to have persistent data over multiple plays. It would be most useful for RPGs.

Call this function just before a user creates a new character. Keep in mind that each user is allowed 6 save slots per mod, and that this function only generates an ID (it does not reserve it).

Client --> {"type":"CREATE","modID":"XXXXXXXXX","steamID":"1234"}

Server --> {"type":"create","result":"success","saveID":"1"}

Call this function when you want to update the data saved for a specific saveID. The saveID is obtained from the LIST or CREATE functions. A save can only collide with other saves from the same user.

Client --> {"type":"SAVE","modID":"XXXXXXXXX","steamID":"1234","saveID":"1","jsonData":[{"test":"value","test2":"value2"}],"metaData":"example_character_save_name"}

Server --> {"type" : "save", "result" : "success"}

Call this function when you want to delete a saveID. The saveID is obtained from the LIST or CREATE functions. A save can only collide with other saves from the same user.

Client --> {"type":"DELETE","modID":"XXXXXXXXX","steamID":"1234","saveID":"1"}

Server --> {"type" : "delete", "result" : "success"}

Call this function when you want to load a specific saveID. The saveID is obtained from the LIST or CREATE functions. A save can only collide with other saves from the same user.

Client --> {"type":"LOAD","modID":"XXXXXXXXX","steamID":"1234","saveID":"1"}

Server --> {"type":"load","result":"success","jsonData":[{"test":"value","test2":"value2"}]}

Call this function at the start of the game to get a list of all of the user's saves for this mod.

Client --> {"type":"LIST","modID":"XXXXXXXXX","steamID":"1234"}

Server --> {"type":"list","result":"success","jsonArray":[{"saveID":1,"metaData":"example_character_save_name","dateRecorded":"2015-03-25T02:08:53.000Z"},{"saveID":2,"metaData":"example_character_save_name","dateRecorded":"2015-03-25T02:19:56.000Z"},{"saveID":3,"metaData":"example_character_save_name","dateRecorded":"2015-03-25T02:20:01.000Z"},{"saveID":4,"metaData":"example_character_save_name","dateRecorded":"2015-03-25T02:20:06.000Z"}]}

Always listen for the error and result fields. If error is populated, then something went wrong and you may want to indicate the raw error to the user in the client, otherwise you may want to communicate the result to the user (optional).

• Live: 4446
• Test: 4444