backend server for The Guildmaster (check https://github.com/Athoir/The_Guildmaster)
- Have node.js and mongoDB installed on your computer
- clone the git repository
- type on your CLI
npm installwhen you are in the folder of the repository - run mongoDB and type
npm run startto run the server - the default port for the server is
localhost:3000to change it, go in/config/default.jsonand change theportvalue
If you want to change the reset timer for quests, go into /config/default.json and change the fields value and/or unit
in the object quest.reset
/ to check if the server is ready
/player to create a player, returns the complete object of the player created, the route wait a body looking like:
{ "name": "Jojo", "googleId": "f4vs548", "email": "[email protected]" } with the Header Content-type: application/json
/player/login/:googleId to check if the player has an account assigned to his googleId
returns a status code 200 with the _id of the player if one has been found
if no player has been found, returns a code 404 with an _id: null
/player/:playerId to get only the mains informations of the player
{ name: String, googleId: String, reputation: Number, money: Number }
/player/:playerId/complete to get the complete object of the player if the request is done without the header
Content-type: application/json, returns an html page with the player informations
/player/:playerId/character to recruit a new character, just send {class: "classWanted"} in the body
returns the list of all characters
/player/:playerId/character/:characterId to update a new character, send { cost: 100, weaponLevel: 1, armorLevel: 5 }
returns the caracters
/player/:playerId/character returns the list of the player's characters
/player/:playerId/quest/:questId/start to start a quest, return the current quests
the body expected is { characters: [characterId, charaterId] }
/player/:playerId/quest/:questId/validate to validate a finished quest and claim the reward, return a message
no body expected
/player/:playerId/quest to get both available and current quests
/player/:playerId/quest/available to get the available quests
{ generatedAt: Date, quests: [ { questType: String, level: Number, length: Number, lethality: Number, reward: Number } ] }
/player/:playerId/quest/current to get the current quests
[ { endAt: Date, questType: String, level: Number, length: Number, lethality: Number, reward: Number } ]