Open Peptide90 opened 6 months ago
Guidebooks PR has been merged so you can find the existing directory here: https://github.com/Vault-Overseers/nuclear-14/tree/master/Resources/ServerInfo/Guidebook/Nuclear14
All of the current entries are placeholders that need content adding to.
Description
We need guidebook entries for all sorts of stuff to help guide players new to the fallout universe, new to RP and just curious about learning more.
Below is an outline of guidebooks that need added, as well as a guide below that on how to contribute guidebooks for newbies.
To Do List
Factions
Weapons & Ammo
Lore
Mobs / AI
Medicine
Crafting
Guide
Check out pull request #153 and check out the file changes page to see what it takes to add guidebooks.
Guidebooks consist of:
Resources/Prototypes/Nuclear14/Guidebooks
. This is a yml file and easily edited in notepad++ like the other files.Resources/Locale/en-US/Nuclear14/guidebooks.ftl
and these are what translate the file name to something readable in game. Simple format e.g.guide-entry-nuclear14 = Nuclear 14
/ServerInfo/Guidebook/Nuclear14/
but go up a folder and you'll see the upstream entries for guidance.Now let's explore the factions guidebooks to see what needs to be done to structure some guidebook entries.:
Above is an example of a top level directory, in this face Factions. Factions is a child of
Nuclear14
as specified in another guidebook prototype but in this fileFactions
also has it's own children listed. One of the entries isBrotherhoodOfSteel
. This matches the ID on the next entry down. The children ID and theguideEntry
ID must match for it to show as a child entry in game. This is repeated again for the individual faction entry with no children at the bottom.In each case we can see a unique ID for each entry linked to the above entry through the
children:
list, each one has a name specified asguide-entry-name
which links to our localisation file mentioned earlier, and finally atext:
path which leads to the xml document with the contents.