An API that allows you to sate the urge that you sometimes get to tell someone about your RPG character, and to explore the diverse cast of characters played by your peers. With the loss of the Heroku free plan, this project is currently on hold.
Report Bug
·
Request Feature
LMTYA-My-Character is an API that allows you to search a database of RPG characters. Whose characters? Your characters!
That's right, fellow RPG lover! Do you have a character (or characters) that you are dying to tell someone about? Now you can! I would absolutely love to hear about your character!
In return, you get to help grow the database, fulfill your need to talk about your favorite character, get credited as a contributor, and increase your daily commit count on GitHub! What's not to like?
To contribute to the project, all you have to do is follow these 6 simple steps.
- Fork the Project
- Create a new branch (
git checkout -b add_new_character) - Add your character to
charList.js(please see the guidelines below) - Commit your Changes (
git commit -m 'Add new character') - Push to the Branch (
git push origin add_new_character) - Open a Pull Request
If you're a first-time contributor to GitHub, I strongly recommend checking out Contribute to this project by Syknapse, which includes an exhaustive walkthrough of the process.
In order to add your character to the list, please copy the template found at the start of the charList.js file
{
name: "",
player: "",
system: "",
campaign_world: "",
race: "",
gender: "",
age: "",
description: "",
summary: "",
factoid: "",
quote: "",
fav_weapon: "",
fav_skills: [""],
fav_spells: [""],
class: [""],
sub_class: [""],
level: [],
},
and paste it at the end of the characters array. Fill out as many of the entires as you'd like and leave the rest as empty strings ("").
This template was designed with D&D/Pathfinder-type systems in mind and not all fields may be applicable to your character.
- Please use lower case letters only for every entry other than
name,description,summary,factoidandquote. - Please keep
description,summary,factoidandquoteto one or two sentences. (Sorry, it was difficult for me, too!) - values for
systemshould avoid special characters. For example,dnd5eworks.d&d3.5is right out. Acceptable values includednd5e,dnd4e,pathfinder1e,pathfinder2e,bitd,dsa,motw(Hmm, I might have to make a chart.) descriptionshould be a physical description of your charactersummaryshould be a synopsis of their personality or characteristicsfactoidcould be any random fact about your characterquotecould be something your character often says, thinks, or feels
class, sub_class, and level should be entered in the same order:
["primaryClass", "secondaryClass"]
["primarySubclass", "secondarySubclass"]
["primaryLevel", "secondaryLevel"]
For example, a Lvl 9 Wizard (transmuter), lvl 3 Rogue (Arcane Trickster) would format the entries as follows:
class: ["wizard", "rogue"],
sub_class: ["transmuter", "arcane trickster"]
level: [9, 3]
Here's an example entry:
{
name: "Octavia Gallo",
player: "nicoleb",
system: "pathfinder1e",
campaign_world: "golarion",
race: "human",
gender: "female",
age: "17",
description: "A slender young woman with a mass of auburn hair. Her duelling blade is always at her side.",
summary: "A hot-headed and somewhat naive young follower of Iomedae.",
factoid: "Prone to jumping out of windows in pursuit of her foes.",
quote: "I promise we'll make this right.",
fav_weapon: "duelling blade",
fav_skills: ["acrobatics", "diplomacy"],
fav_spells: [""],
class: ["paladin", "swashbuckler"],
sub_class: ["virtuous bravo", "bravo"],
level: [5, 1],
}
- Flesh out API documentation
- Add additional search types
- Enable multi-parameter searches
- Transfer the character file to MongoDB???
See the open issues for a full list of proposed features (and known issues).
Distributed under the MIT License. See LICENSE.txt for more information.
Twitter: @NicoleBarnabee
Project Link: https://github.com/github_username/repo_name