Back Attackerator is the repository for the backend/server half of the Attackerator project. Attackerator tries to solve a problem with table top rpg's and having to keep track of all your character data, as well as preforming the correct rolls for various actions.
For info on the front end refer to the repository:
https://github.com/Attackerator/frontAttackerator
This route allows you to create a user by sending a request body with the following:
- Email | String | Required
- Username | String | Required
- Password | String | Required
This route allows you to log into your account by sending a request body with the following:
- Username | String | Required
- Password | String | Required
This route allows you to update your account info with a new username and/or password by sending a request body with one or both of the following:
- Username | String
- Password | String
This route allows you to delete your account from our database if you've decided you hate our services by sending a request body with the following:
- User id | ObjectId | Required
Once you've created an account the next step is to create a character, these are all the routes involving the characters.
Just pass this route a request body with the following to create a new character
- Character name | String |
This route allows you to retrieve a character you have created by sending a request body with the following:
- Character id | ObjectId | Required
This route allows you update your character name by sending a request body with the following:
- Character name | String
This route allows you to delete a character by sending a request body with the following:
- Character id | ObjectId | Required
Once you have your character you're gonna need some stats
This route allows you to create stats for your character by sending a request body with the following:
- Strength | Number
- Dexterity | Number
- Constitution | Number
- Intelligence | Number
- Charisma | Number
- Wisdom | Number
if nothing is provided the value with default to 3.
This route returns a stat with the provided an id like the following:
- Stat id | ObjectId | Required
This route allows you to update your stats with provided the following:
- Strength | Number
- Dexterity | Number
- Constitution | Number
- Intelligence | Number
- Charisma | Number
- Wisdom | Number
If for some reason you'd like to delete your stats you can by providing the following:
- Stat id | ObjectId | Required
It helps to be able to create and manage attacks for your character if you want to accomplish much.
This route allows you to create an attack for a character my providing the following:
- Name | String | Required
- Stat | String | Required
- Damage Type | String | Required
- Dice Type | Number | Required
- Dice Count | Number | Required
- Description | String
- To Hit Bonus | Number
- Damage Bonus | Number
This route allows you to access an attack by providing the following:
- Attack id | ObjectId | Required
This route allows you to update any of the info for an attack by providing the following:
- Name | String
- Stat | String
- Damage Type | String
- Dice Type | Number
- Dice Count | Number
- Description | String
- To Hit Bonus | Number
- Damage Bonus | Number
This route allows you to delete a specified attack by providing an id like the following:
- Attack id | ObjectId | Required
Attacks are fun but spells can also be really interesting, the routes are going to be really similar though.
- Name | String | Required
- Stat | String | Required
- Damage Type | String | Required
- Dice Type | Number | Required
- Dice Count | Number | Required
- Description | String
- To Hit Bonus | Number
- Damage Bonus | Number
This route allows you to access a spell by providing the following:
- Spell id | ObjectId | Required
This route allows you to update any of the info for a spell by providing the following:
- Name | String
- Stat | String
- Damage Type | String
- Dice Type | Number
- Dice Count | Number
- Description | String
- To Hit Bonus | Number
- Damage Bonus | Number
This route allows you to delete a specified spell by providing an id like the following:
- Spell id | ObjectId | Required
These routes will allow you to interact with skills for your character
This route with allow you to create a skill for a character by providing the following:
- Name | String | Required
- Bonus | Number | Required
- Stat | String
This route allows you to retrieve a specified skill by providing the following:
- Skill id | ObjectId | Required
This route allows you to update a specified skill by providing one or all of the following:
- Name | String
- Bonus | Number
- Stat | String
This route allows you to delete a specified skill by providing the following:
- Skill id | ObjectId | Required
These routes our for saving throws for your character, not to mistaken for saving something for later.
This route allows you to create a save for a character by providing the following:
- Type | String | Required
- Stat | String | Required
- Bonus | Number
This route allows you to retrieve a specified save by providing the following:
- Save id | ObjectId | Required
This route allows you to update a specified save by providing one or more of the following:
- Type | String
- Stat | String
- Bonus | Number
This route allows you to delete a specified save by providing the following
- Save id | ObjectID | Required
============================================================================
That concludes the routes, for information on the front end see the repository for the front end: