Package: hyperborea3
hyperborea3An app for creating randomly-generated characters for theHyperborea3rd edition tabletop roleplaying game.Table of Contentshyperborea3Table of ContentsInstallationUsageParametersSample Outputclass_id_mapUse CasesLinksFuture DevelopmentContributionsInstallation$python-mpipinstallhyperborea3UsageThe main entry point to this application is thePlayerCharacterclass. By default, a random character will be generated with the following options:Abilities are rolled using dice method III (4d6 drop lowest)Class is randomly selected from amongst those where ability score requirements are met0 experience pointsAll character class options are enabledThe by-the-book descending Armour Class system is usedfrompprintimportpprintfromhyperborea3.player_characterimportPlayerCharacterpc=PlayerCharacter()pprint(pc.to_dict())SeeSample Outputfor some examples of what the generated characters look like.ParametersParameterDescriptionmethodint, default 3Dice method used to roll ability scores.Allowed Values: If noclass_idis passed,1,2,3,4,5may be used. If a specificclass_idother than0is passed, any value passed is ignored andmethod=6is automatically used.Example:pc = PlayerCharacter(method=5)to create a random-classed PC using dice method V for rolling ability scores.class_idint, default 0If0, a random class will be selected and dice methods 1 through 5 can be used. Otherwise, a value of 1 to 33 can be entered, and the dice method will automatically be set to 6, regardless of what is passed.Allowed Values:0through33. Seeclass_id_mapbelow.Example:pc = PlayerCharacter(class_id=10)to create a Ranger.subclassesint, default 2Determines which classes are selected from when generating a character of a random class.Allowed Values:0=Principal classes only (Fighter, Magician, Cleric, Thief);1=Principal classes plus subclasses;2=Principal classes, subclasses, and variant subclasses like the Ice Thief and Fell Paladin.Example:pc = PlayerCharacter(subclasses=0)to create a random character from one of the 4 principal classes.xpint, default 0The number of experience points the character has. This will determine the character's level, which is capped at 12.Allowed Values: Any positive integerExample:pc = PlayerCharacter(class_id=1, xp=4000)to create a 3rd-level Fighter.ac_typestr, default "descending"Choose whether to use ascending or descending AC system.Allowed Values:"descending","ascending"Example:pc = PlayerCharacter(ac_type="ascending")Sample OutputCheck out thedirectory of sample charactersto examine and explore the data structures.class_id_mapUse this as a reference if you need to passclass_idto generate a character of a specific class.1:"Fighter"2:"Magician"3:"Cleric"4:"Thief"# --------------> subclasses=0 will return a choice from above this line5:"Barbarian"6:"Berserker"7:"Cataphract"8:"Huntsman"9:"Paladin"10:"Ranger"11:"Warlock"12:"Cryomancer"13:"Illusionist"14:"Necromancer"15:"Pyromancer"16:"Witch"17:"Druid"18:"Monk"19:"Priest"20:"Runegraver"21:"Shaman"22:"Assassin"23:"Bard"24:"Legerdemainist"25:"Purloiner"26:"Scout"# --------------> subclasses=1 will return a choice from above this line27:"Fell Paladin"28:"Ice Lord"29:"Fire Lord"30:"Death Soldier"31:"Mountebank"32:"Fire Thief"33:"Ice Thief"# --------------> subclasses=2 will return a choice from above this lineUse CasesI developed this package to generate characters for my personal gaming group. I use the package along with FastAPI and host the app on Heroku. I use it in conjunction with Google's app script (javascript) to get the character data from the Heroku endpoint, and populate it into a Google Sheets character sheet. It's a bit janky, but it gets the job done for us. I put a lot of work into implementing the rules to generate characters of any class and any level up to the game's maximum of level 12.If someone out there were to use this and create a proper front-end website for it, that would bring me much joy. If you use this, please share what you've built with it!That being said, I also plan to hone my own web skills and try to build a web-based front end for it, but that will take time.LinksApp on render:  All the endpoints prefixed with/hyperborea3/use this package. If you are curious about the container that gets deployed, seethis repo.Google Sheet: with character generator integrated via Google'sApps Script. If you are intersted in simply making a copy of the Google Sheet character generator for your gaming group to use, seethis blog postfor instructions on how to do that.Future DevelopmentI plan to implement the following features into this package, as time and motivation allows:Additional character data:Secondary SkillsRandom name generation based on the tables in the rulebookHeight and Weight based on the tables in the rulebookAdd detailed html-formatted spell descriptions to the spells database table in order to enable spell lookups and possibly some sort of tool to create character spellbook documents. Detailed spell information could be added to the character output as well.A fully-detailed monster database table that would enable the lookup of full monster stat blocks.A random treasure generator tool. Pass the treasure type and get a randomly generated result with monetary treasure and/or magic items.Given completed spells, monsters, and treasure data, I'd like to create compendiums for use withFoundry VTT.ContributionsPull requests for small updates and bug fixes are always welcome. If you have a larger update you're interested in contributing, please create an Issue and we can have a conversation about it. If you are a talented front end developer and are interested in creating pretty web tools for this, I'd love to do whatever I can to help you!