FG Spreadshirt Swag
  1. #1
    Varsuuk's Avatar
    Join Date
    Dec 2015
    Location
    New York
    Posts
    2,075

    Recommended ruleset module reference section naming?

    I was updating my drag and drop for races and looking at 5E for info, I noticed when I wrote my mod file it used reference.races for races not reference.racedata.

    A memory of a page that listed the common paths and exceptions for different rulesets like 5E, SW, C&C etc came to mind and I assumed that races was the recommend and 5E an exception. I couldn't find the exact page from my memory - probably missed it but in case it was removed/changed I figured ask here. This is the page I DID find:
    https://www.fantasygrounds.com/wiki/..._File_Overview

    But I figure it is specifically coreRPG and the other page is out there?

    Code:
    CoreRPG Data File Format
    
    With the CoreRPG ruleset and those rulesets derived from it, the ruleset assumes that records are laid out within specific data paths within the data file. Each child of the corresponding paths is considered a complete record of that type. The individual subtree and leaf nodes within each record type vary dramatically by ruleset.
    The best way to see an example of the data file format for a specific data type is to create a record of the desired type within a campaign, and view the campaign db.xml file in a text editor after saving the campaign.
    Here are the standard CoreRPG data record paths for editable record data:
    charsheet = PC data
    notes = Notes data
    encounter = Story data
    storytemplate = Story template data
    image = Image and map data
    quest = Quest data
    npc = NPC data
    battle = Encounter data (i.e. NPC groups)
    battlerandom = Random encounter data
    item = Item data
    treasureparcels = Parcel data (i.e. Item groups)
    tables = Table data
    modifiers = Modifier data
    effects = Effect data
    library = Library data
    Additionally, the standard for modules within the CoreRPG ruleset is to specify the "reference" path as read only. Thus, the standard CoreRPG data record paths for read only data are:
    reference.encounters = Story data
    reference.storytemplates = Story template data
    reference.quests = Quest data
    reference.images = Image and map data
    reference.npcs = NPC data
    reference.battles = Encounter data (i.e. NPC groups)
    reference.battlerandoms = Random encounter data
    reference.items = Item data
    reference.treasureparcels = Parcel data (i.e. Item groups)
    reference.tables = Table data
    Also, there are standard paths used within the CoreRPG ruleset to store tool data:
    combattracker = Combat tracker data
    partysheet = Party sheet data
    calendar = Calendar data
    export = Export data
    options = Option data

  2. #2

    Join Date
    May 2016
    Location
    Jacksonville, FL
    Posts
    2,211
    Blog Entries
    7
    You were probably looking for Data Structure Overview and Best Practices.

  3. #3
    Varsuuk's Avatar
    Join Date
    Dec 2015
    Location
    New York
    Posts
    2,075
    AWESOME *exactly* what I was remembering.

    OK - so I will then leave my PHB module using the "reference.races" thing as that is recommended going forward as I read it. Thanks

  4. #4

    Join Date
    May 2016
    Location
    Jacksonville, FL
    Posts
    2,211
    Blog Entries
    7
    If you're working in 5E that page does still say reference.racedata unless JPG changed the ruleset but not the wiki page?

  5. #5
    I was attempting to define a scheme that was semi-consistent going forward; but several existing rulesets had data using alternate names that would have been difficult to retcon. So, I would use the recommended paths, unless you have a good reason not to.

    Cheers,
    JPG

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
Starfinder Playlist

Log in

Log in