SGDK
A free and open development kit for the Sega Mega Drive
•All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
gamejolt.h
Go to the documentation of this file.
1/************************************************************************/
23
24#ifndef _GAMEJOLT_H_
25#define _GAMEJOLT_H_
26
27#include "types.h"
28
29#if (MODULE_MEGAWIFI != 0)
30
36enum gj_error {
37 GJ_ERR_NONE = 0,
38 GJ_ERR_PARAM = -1,
39 GJ_ERR_REQUEST = -2,
40 GJ_ERR_RECEPTION = -3,
41 GJ_ERR_RESPONSE = -4,
42 GJ_ERR_PARSE = -5
43};
44
46enum gj_trophy_difficulty {
47 GJ_TROPHY_TYPE_BRONZE = 0,
48 GJ_TROPHY_TYPE_SILVER,
49 GJ_TROPHY_TYPE_GOLD,
50 GJ_TROPHY_TYPE_PLATINUM,
51 GJ_TROPHY_TYPE_UNKNOWN
52};
53
55enum gj_data_store_update_operation {
56 GJ_OP_ADD = 0,
57 GJ_OP_SUBTRACT,
58 GJ_OP_MULTIPLY,
59 GJ_OP_DIVIDE,
60 GJ_OP_APPEND,
61 GJ_OP_PREPEND,
62 GJ_OP_MAX
63};
64
66#define GJ_TROPHY_RESPONSE_TABLE(X_MACRO) \
67 X_MACRO(id, string, char*) \
68 X_MACRO(title, string, char*) \
69 X_MACRO(difficulty, trophy_difficulty, enum gj_trophy_difficulty) \
70 X_MACRO(description, string, char*) \
71 X_MACRO(image_url, string, char*) \
72 X_MACRO(achieved, string, char*)
73
75#define GJ_TIME_RESPONSE_TABLE(X_MACRO) \
76 X_MACRO(timestamp, string, char*) \
77 X_MACRO(timezone, string, char*) \
78 X_MACRO(day, string, char*) \
79 X_MACRO(hour, string, char*) \
80 X_MACRO(minute, string, char*) \
81 X_MACRO(second, string, char*)
82
84#define GJ_SCORE_RESPONSE_TABLE(X_MACRO) \
85 X_MACRO(score, string, char*) \
86 X_MACRO(sort, string, char*) \
87 X_MACRO(extra_data, string, char*) \
88 X_MACRO(user, string, char*) \
89 X_MACRO(user_id, string, char*) \
90 X_MACRO(guest, string, char*) \
91 X_MACRO(stored, string, char*) \
92 X_MACRO(stored_timestamp, string, char*)
93
95#define GJ_SCORE_TABLE_RESPONSE_TABLE(X_MACRO) \
96 X_MACRO(id, string, char*) \
97 X_MACRO(name, string, char*) \
98 X_MACRO(description, string, char*) \
99 X_MACRO(primary, bool_num, bool)
100
102#define GJ_SCORE_GETRANK_RESPONSE_TABLE(X_MACRO) \
103 X_MACRO(message, string, char*) \
104 X_MACRO(rank, string, char*)
105
107#define GJ_USER_RESPONSE_TABLE(X_MACRO) \
108 X_MACRO(id, string, char*) \
109 X_MACRO(type, string, char*) \
110 X_MACRO(username, string, char*) \
111 X_MACRO(avatar_url, string, char*) \
112 X_MACRO(signed_up, string, char*) \
113 X_MACRO(signed_up_timestamp, string, char*) \
114 X_MACRO(last_logged_in, string, char*) \
115 X_MACRO(last_logged_in_timestamp, string, char*) \
116 X_MACRO(status, string, char*) \
117 X_MACRO(developer_name, string, char*) \
118 X_MACRO(developer_website, string, char*) \
119 X_MACRO(developer_description, string, char*)
120
122#define X_AS_STRUCT(field, decoder, type) \
123 type field;
124
126struct gj_trophy {
127 GJ_TROPHY_RESPONSE_TABLE(X_AS_STRUCT);
128 bool secret;
129};
130
132struct gj_time {
133 GJ_TIME_RESPONSE_TABLE(X_AS_STRUCT);
134};
135
137struct gj_score {
138 GJ_SCORE_RESPONSE_TABLE(X_AS_STRUCT);
139};
140
142struct gj_score_table {
143 GJ_SCORE_TABLE_RESPONSE_TABLE(X_AS_STRUCT);
144};
145
147struct gj_user {
148 GJ_USER_RESPONSE_TABLE(X_AS_STRUCT);
149};
150
151/************************************************************************/
174bool gj_init(const char *endpoint, const char *game_id, const char *private_key,
175 const char *username, const char *user_token, char *reply_buf,
176 uint16_t buf_len, uint16_t tout_frames);
177
178/************************************************************************/
186enum gj_error gj_get_error(void);
187
188/************************************************************************/
198char *gj_trophies_fetch(bool achieved, const char *trophy_id);
199
200/************************************************************************/
214char *gj_trophy_get_next(char *pos, struct gj_trophy *trophy);
215
216/************************************************************************/
223bool gj_trophy_add_achieved(const char *trophy_id);
224
225/************************************************************************/
232bool gj_trophy_remove_achieved(const char *trophy_id);
233
234/************************************************************************/
242const char *gj_trophy_difficulty_str(enum gj_trophy_difficulty difficulty);
243
244/************************************************************************/
251bool gj_time(struct gj_time *time);
252
253/************************************************************************/
268char *gj_scores_fetch(const char *limit, const char *table_id,
269 const char *guest, const char *better_than,
270 const char *worse_than, bool only_user);
271
272/************************************************************************/
286char *gj_score_get_next(char *pos, struct gj_score *score);
287
288/************************************************************************/
294char *gj_scores_tables_fetch(void);
295
296/************************************************************************/
310char *gj_score_table_get_next(char *pos, struct gj_score_table *score_table);
311
312/************************************************************************/
320char *gj_scores_get_rank(const char *sort, const char *table_id);
321
322/************************************************************************/
333bool gj_scores_add(const char *score, const char *sort, const char *table_id,
334 const char *guest, const char *extra_data);
335
336/************************************************************************/
346bool gj_data_store_set(const char *key, const char *data, bool user_store);
347
348/************************************************************************/
359char *gj_data_store_keys_fetch(const char *pattern, bool user_store);
360
361/************************************************************************/
375char *gj_data_store_key_next(char *pos, char **key);
376
377/************************************************************************/
387char *data_store_fetch(const char *key, bool user_store);
388
389/************************************************************************/
400char *gj_data_store_update(const char *key,
401 enum gj_data_store_update_operation operation,
402 const char *value, bool user_store);
403
404/************************************************************************/
413bool gj_data_store_remove(const char *key, bool user_store);
414
415/************************************************************************/
420bool gj_sessions_open(void);
421
422/************************************************************************/
430bool gj_sessions_ping(bool active);
431
432/************************************************************************/
446bool gj_sessions_check(const char *username, const char *user_token);
447
448/************************************************************************/
453bool gj_sessions_close(void);
454
455/************************************************************************/
468char *gj_users_fetch(const char *username, const char *user_id);
469
470/************************************************************************/
484char *gj_user_get_next(char *pos, struct gj_user *user);
485
486/************************************************************************/
495bool gj_users_auth(void);
496
497/************************************************************************/
503char *gj_friends_fetch(void);
504
505/************************************************************************/
519char *gj_friend_get_next(char *pos, char **user_id);
520
521/************************************************************************/
537char *gj_request(const char **path, uint8_t num_paths, const char **key,
538 const char **value, uint8_t num_kv_pairs, uint32_t *out_len);
539
540#endif // MODULE_MEGAWIFI
541
542#endif /*_GAMEJOLT_H_*/
543
545
types.h
Types definition.