This API works in 2 different modes:
- Single Player
- Multiplayer
All the rules are implemented, so dont't worry about that.
Create a new game is simple, just send a json like below to:
http://<server-name>/api/mastermind/newgame
{
"user": "Name"
}You'll receive a response like that:
{
"colors": [
"R",
"B",
"G",
"Y",
"O",
"P",
"C",
"M"
],
"codeLength": 8,
"gamekey": "E6aFPF0t5EmVGcwnumjcPw==",
"numGuesses": 0,
"pastResults": [],
"solved": false
}- colors The colors that you can chose to set the guess code.
- codeLength The exact length you have to create the guess code.
- gamekey The game identifier.
- numGuesses The number that you tried guess the code.
- pastResults All results of your guesses.
- solved Game's solved.
The next step is send your guess for:
http://<server-name>/api/mastermind/guess
using:
{
"code": "GUESSCODE",
"gamekey": "E6aFPF0t5EmVGcwnumjcPw=="
}After the play you'll receive the follow responses:
When you don t solved the code:
{
"codeLength": 8,
"colors": [
"R",
"B",
"G",
"Y",
"O",
"P",
"C",
"M"
],
"gamekey": "E6aFPF0t5EmVGcwnumjcPw==",
"guess": "OPORCCGB",
"numGuesses": 1,
"pastResults": [
{
"exact": 0,
"guess": "OPORCCGB",
"near": 4
}
],
"result": {
"exact": 0,
"near": 4
},
"solved": false
}When you solve the code:
{
"codeLength": 8,
"furtherInstructions": "Solve the challenge to see this!",
"colors": [
"R",
"B",
"G",
"Y",
"O",
"P",
"C",
"M"
],
"gamekey": "y32slt4e5E6nW28f6hLbuw==",
"guess": "GRGMMGCO",
"numGuesses": 3,
"pastResults": [
{
"exact": 0,
"guess": "OPORCCGB",
"near": 4
},
{
"exact": 0,
"guess": "OPORCCGB",
"near": 4
},
{
"exact": 8,
"guess": "GRGMMGCO",
"near": 0
}
],
"result": "You win!",
"solved": true,
"timeTaken": 54,
"user": "felix"
}Congratulations you win.
First Player In this mode will be necessary to send some new data to start the game, example below:
http://<server-name>/api/mastermindmultiplayer/join
{
name:"UserName",
role:"CodeBreaker",
roomId:""
}- role you just can chose for two roles, these are CodeMaker or CokeBreaker
You'll receive a response with the gamekey, room id and message. The message says you need wait for second player.
{
"gamekey": "2rNym4JyF0uEQKWkYsB/Qw==",
"roomdId": "e4938012-1478-480d-b53f-e2eea8134164",
"message": "You are joined. Waiting for the second player!"
}Second Player Necessary to send the name, role and room id of the room selected. In case you've sent the same role for room that already has a player with the same role, a new room will be created.
http://<server-name>/api/mastermindmultiplayer/join
{
name:"UserName",
role:"CodeMaker",
roomId:"e4938012-1478-480d-b53f-e2eea8134164"
}After sent the post data will receive this response:
{
"gamekey": "RAbh2lk1okKmfSrbSpcXCA==",
"roomdId": "4778f056-ec16-429e-9149-5ecab914b93d",
"message": "You are joined. Waiting for the second player!"
}Now the second player needs to send the secret code to:
http://<server-name>/api/mastermindmultiplayer/setsecretcode
{
username:"UserName",
roomId: "28e7ea1e-a6d2-4a88-970a-9bba0a5d9aad",
code:"MMMMMMMM"
}The response:
{
"isReady": true,
"message": "Secret code is set. Good luck for Code Breker, Enjoy!"
}So, now you "Code Breaker" are ready to start the guesses sending to...:
http://<server-name>/api/mastermindmultiplayer/tryguesscode
Sending now the gamekey, that you already have kept in older posts.
{
gamekey:"hwrmzL9GEkeJghErMCW3zA==",
code:"YCPORMGB"
}The response will be:
When you dont solved the code:
{
"result":{
"codeLength": 8,
"colors": [
"R",
"B",
"G",
"Y",
"O",
"P",
"C",
"M"
],
"gamekey": "E6aFPF0t5EmVGcwnumjcPw==",
"guess": "OPORCCGB",
"numGuesses": 1,
"pastResults": [
{
"exact": 0,
"guess": "OPORCCGB",
"near": 4
}
],
"result": {
"exact": 0,
"near": 4
},
"solved": false
}
}When you solve the code:
{
"result":{
"codeLength": 8,
"furtherInstructions": "Solve the challenge to see this!",
"colors": [
"R",
"B",
"G",
"Y",
"O",
"P",
"C",
"M"
],
"gamekey": "y32slt4e5E6nW28f6hLbuw==",
"guess": "GRGMMGCO",
"numGuesses": 3,
"pastResults": [
{
"exact": 0,
"guess": "OPORCCGB",
"near": 4
},
{
"exact": 0,
"guess": "OPORCCGB",
"near": 4
},
{
"exact": 8,
"guess": "GRGMMGCO",
"near": 0
}
],
"result": "You win!",
"solved": true,
"timeTaken": 54,
"user": "UserName"
}
}If you want to see a nostalgic and themed front-end using axiom-zen API, just go to:
http://<server-name>/index.html
That's all folks.
Thanks.