DrXama_gameJolt
Esse plugin permite a integração do Game Jolt ao seu projeto, fornecendo suporte completo da API do Game Jolt aos desenvolvedores.
Tenha a API do seu jogo no Game Jolt antes de iniciar.
Primeiro vamos pegar o Game ID e o Private Key.
- Clique na sua foto, e depois clique no menu Game Library.
- Escolha o seu jogo.
- Clique na engrenagem(Manage Game).
- Clique em Game API.
- Clique em API Settings.
Agora que já estamos com os valores prontos vamos para o RPG MAKER MV.
A instalação do plugin no MAKER é padrão.
Coloque os arquivos .html dentro da pasta gamejolt que deve ficar localizada dentro da pasta do raiz do projeto..
Está tudo pronto, agora é só trocar os valores dos parâmetros para os valores que buscamos no Game Jolt na Parte 1.
Ao sair do jogo todas as sessões dos usuários serão finalizadas.
Todos os comandos relacionados aos usuários, deverão ser feitos apos o login dos usuários. Espere a conclusão do login para iniciar um comandos relacionado a algum usuário.
O sistema efetua um Ping na sessão do usuário a cada 3600(milissegundo), para informar que o mesmo se encontra ativo. Por padrão o Game Jolt finaliza a sessão do usuário, apos 30 segundos de ausência.
Suporte a múltiplos usuários ao mesmo tempo.
Game ID: ID do seu jogo.
Private Key: Chave de acesso ao seu jogo.
Text Connected: Texto apresentado quando o usuário é conectado.
Text Disconnected: Texto apresentado quando o usuário é desconectado.
Text AddPonts: Texto apresentado quando o usuário marca uma pontuação.
Text AddTrophies: Texto apresentado quando o usuário recebe um troféu.
Text RemoveTrophies: Texto apresentado quando o usuário perde um troféu.
Text Login Page: Textos apresentados na tela de login.
Text Logout Page: Textos apresentados na tela de logout.
GameJoltAddUser: Adiciona um novo usuário do Game Jolt ao seu jogo.
GameJoltLoginUser: Inicia a sessão do usuário no jogo.
GameJoltLogoutUser: Finaliza a sessão do usuário no jogo.
GameJoltScoresAddPoints: Adiciona o score do usuário a uma tabela do Scoreboards.
GameJoltScoresAddGuestPoints: Adiciona o score do convidado a uma tabela do Scoreboards.
GameJoltTrophiesAddUser: Adiciona um troféu para o usuário.
GameJoltTrophiesRemoveUser: Remove o troféu do usuário.
GameJoltOpenWindowLogin : Exibe a janela de login.
GameJoltOpenWindowLogout: Exibe a janela de logout
GameJoltAddUser Username Game Token
GameJoltLoginUser Username
GameJoltLogoutUser Username
GameJoltScoresAddPoints Username TableID Score ScoreLimit
GameJoltScoresAddGuestPoints Guestname TableID Score ScoreLimit
GameJoltTrophiesAddUser Username TrophyID
GameJoltTrophiesRemoveUser Username TrophyID
$gameTemp.gameJoltAddUser: Adiciona um novo usuário do Game Jolt ao seu jogo.
$gameTemp.gameJoltLoginUser: Inicia a sessão do usuário no jogo.
$gameTemp.gameJoltLogoutUser: Finaliza a sessão do usuário no jogo.
$gameTemp.gamejoltScoresUserTable: Retorna o score do jogador em determinada tabela do Scoreboards.
$gameTemp.gamejoltScoresTables: Retorna todas as tabelas do Scoreboards.
$gameTemp.gamejoltScoresAddPoint: Adiciona o score do usuário a uma tabela do Scoreboards.
$gameTemp.gamejoltScoresAddGuestPoints: Adiciona o score do convidado a uma tabela do Scoreboards.
$gameTemp.gamejoltScoresGetRankTables: Retorna a classificação de uma pontuação específica em uma tabela do Scoreboards.
$gameTemp.gamejoltTrophiesUser: Retorna todos os troféus disponíveis para o usuário.
$gameTemp.gamejoltTrophiesAddUser: Adiciona um troféu para o usuário.
$gameTemp.gamejoltTrophiesRemoveUser: Remove o troféu do usuário.
$gameTemp.gameJoltOpenWindowLogin: Exibe a janela de login.
$gameTemp.gameJoltOpenWindowLogout: Exibe a janela de logout.
$gameTemp.gameJoltAddUser(username, userToken);
$gameTemp.gameJoltAddUser('DrXama', '4a934x5p');
- username(String): Nome do usuário no Game Jolt.
- userToken(String): Game Token do usuário no Game Jolt.
A função irá retornar true se o registro do usuário for um sucesso, e irá retornar false se o registro não for bem sucedido.
$gameTemp.gameJoltLoginUser(username, callback);
$gameTemp.gameJoltLoginUser('DrXama', response => { return console.log(response); });
- username(String): Nome do usuário no Game Jolt.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar true se o login do usuário for um sucesso, e irá retornar false se o login não for bem sucedido.
$gameTemp.gameJoltLogoutUser(username, callback);
$gameTemp.gameJoltLogoutUser('DrXama', response => { return console.log(response); });
- username(String): Nome do usuário no Game Jolt.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar true se o logout do usuário for um sucesso, e irá retornar false se o logout não for bem sucedido.
$gameTemp.gamejoltScoresUserTable(username, tableID, callback);
$gameTemp.gamejoltScoresUserTable('DrXama', '389349', score => { console.log('Score: ' + score); });
- username(String): Nome do usuário no Game Jolt.
- tableID(String): ID da tabela no Scoreboards.
- callback(Function): Função a ser retornada com a resposta.
O usuário deve está logado para efetuar uma busca pelo score do mesmo.
$gameTemp.gamejoltScoresTables(callback);
$gameTemp.gamejoltScoresTables(response => { return console.log(response); });
- callback(Function): Função a ser retornada com a resposta.
A função retorna uma lista(Array) com todas as tabelas do Scoreboards.
$gameTemp.gamejoltScoresAddPoint(username, tableID, score, sort, callback);
$gameTemp.gamejoltScoresAddPoint('DrXama', '379357', 100, 45, response => { return console.log(response); });
- username(String): Nome do usuário no Game Jolt.
- tableID(String): ID da tabela do Scoreboards.
- score(Number): Score a ser adicionado.
- sort(Number): Valor máximo da tabela ou do score.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar true se a adição da pontuação do usuário for um sucesso, e irá retornar false se a adição da pontuação do usuário não for bem sucedida.
O valor de sort é usado para definir um limite para o valor de score, ou seja, se você definir que score é 100 e sort é 45, o valor a ser registrado na tabela será 45.
$gameTemp.gamejoltScoresAddGuestPoints(guestname, tableID, score, sort, callback);
$gameTemp.gamejoltScoresAddGuestPoints('convidado001', '379357', 100, 45, response => { return console.log(response); });
- guestname(String): Nome do convidado.
- tableID(String): ID da tabela do Scoreboards.
- score(Number): Score a ser adicionado.
- sort(Number): Valor máximo da tabela ou do score.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar true se a adição da pontuação do usuário for um sucesso, e irá retornar false se a adição da pontuação do usuário não for bem sucedida.
O valor de sort é usado para definir um limite para o valor de score, ou seja, se você definir que score é 100 e sort é 45, o valor a ser registrado na tabela será 45.
$gameTemp.gamejoltScoresGetRankTables(tableID, sort, callback);
$gameTemp.gamejoltScoresGetRankTables('379357', 100, response => { return console.log(response); });
- tableID(String): ID da tabela do Scoreboards.
- sort(Number): Valor máximo da tabela ou do score.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar a classificação da pontuação na tabela do Scoreboards.
$gameTemp.gamejoltTrophiesUser(username, trophyId, achieved, callback);
$gameTemp.gamejoltTrophiesUser(username, trophyId, achieved, callback);
- username(String): Nome do usuário no Game Jolt.
- trophyId(String): ID do troféu no Game Jolt.
- achieved(Boolean): Se o troféu foi conquistado pelo usuário.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar uma lista(Array) com todos os troféus do usuário.
Em achieved defina true para retornar apenas os troféus conquistados pelo usuário. Defina false para retornar apenas os troféus que o usuário não conseguiu. Deixe em branco para recuperar todos os troféus.
Em trophyId Se você quiser coletar apenas um troféu, passe a ID do troféu. Se você fizer isso, apenas esse troféu será retornado na resposta. Definir um valor para trophyId irá ignorar o valor de achieved.
$gameTemp.gamejoltTrophiesAddUser(username, trophyId, callback);
$gameTemp.gamejoltTrophiesAddUser('DrXama', '101982', response => { return console.log(response); });
- username(String): Nome do usuário no Game Jolt.
- trophyId(String): ID do troféu no Game Jolt.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar true se a adição do troféu do usuário for um sucesso, e irá retornar false se a adição do troféu do usuario não for bem sucedida.
$gameTemp.gamejoltTrophiesRemoveUser(username, trophyId, callback);
$gameTemp.gamejoltTrophiesRemoveUser('DrXama', '101982', response => { return console.log(response); });
- username(String): Nome do usuário no Game Jolt.
- trophyId(String): ID do troféu no Game Jolt.
- callback(Function): Função a ser retornada com a resposta.
A função irá retornar true se a remoção do troféu do usuário for um sucesso, e irá retornar false se a remoção do troféu do usuario não for bem sucedida.