Hellrider

/*
Subject: Hellrider
Effect: This is a script to install the Hellrider background located at https://norsedmdotcom.files.wordpress.com/2020/05/bg_-dia-session-zero.pdf into the MPMB PDF as transcribed by Thoragh
Sheet: v13 (2023-07-16
*/

var iFileName = "Hellrider.js"; // This is how the file will be named in the sheet if you import it as a file and not copy-paste its content. Only the first occurrence of this variable will be used
RequiredSheetVersion(13); // This is the minimum required version number of the sheet for the script to work. If the sheet being used to import the script is of an earlier version, the user will be warned

SourceList: SourceList["BGDiAHB:HR"] = {
    name: "Baldur's Gate: Descent into Avernus HomeBrew: Hellrider",
    abbreviation: "BGDiAHB:HR",
    group: "BGDiAHB",
    url: "https://justicearman.com/2020/05/04/baldurs-gate-descent-into-avernus-session-zero-companion/",
    date: "2023/07/16"
};

BackgroundList["hellrider"] = { //Object name; Note the use of only lower case! Also note the absence of the word "var" and the use of brackets []
    regExpSearch :  /^(?=.*hell)(?=.*rider).*$/i, //required; regular expression of what to look for (i.e. now it looks for any entry that has the consecutive words "where", "i", "am", and "from" in it, disregarding capitalization or words in between). If this looks too complicated, just write: /background name/i

    name : "Hellrider", //required; the name as used

    source : ["BGDiAHB:HR", 6], //required; the source and the page number. "HB" stands for homebrew. See the "SourceList" above for an overview of the source that is already defined.

    skills : ["Animal Handling", "Persuasion"], //the initial skills Hellrider provides

    gold : 9, //required; the amount of gold pieces added to the Equipment section on the second page when selecting "Hellrider's items and gold" from the "Add Equipment" menu.

    equipleft : [ //optional; syntax is: ["description", "amount", "weight"]. Put "" if it is nothing, don't put 0
        ["Traveler's Clothes", 1, 4],
        ["a signet, a banner or seal with the crest of Elturgard", "", ""],
    ], //items as they are added to the left column of the Equipment section on the second page when selecting "Background's items and gold" from the "Add Equipment" menu.
  equipright: [
        ["Gaming Set or Musical Instrument", 1, ""],
    ],
    feature : "Respected Rider", //required; the name of the background feature as it will appear on the sheet. The feature is then retrieved from the BackgroundFeatureList, see below



    trait : [
        "I tell other Hellriders’ stories as if they were my own.",
        "My armor must remain spotless so that it may reflect the light of the Companion",
        "My horse goes wherever I do.",
        "Only death frees a Hellrider from their post. Some say I welcome it.",
        "I was a hellion growing up. I often take the time to educate (or chastise) children I meet in my adventures.",
        "When I’m on the job, I never crack a smile.",
        "I reserve eye contact for those I respect.",
        "I haven’t cut my hair since I joined the Hellriders."
    ], //required; A list of the personality traits that can be chosen using the "Add Features" button on the second page. This list can be any length.

    ideal : [
        ["Kindness",
            "Kindness: The light of the Companion burns bright within my soul. (Good)"
        ],
        ["justice",
            "Justice: By upholding the law, we defend the rights of all. (Lawful)"
        ],
        ["Fury",
            "Fury: I am relentless in the pursuit and destruction of my enemies. (Evil)"
        ],
        ["Freedom",
            "Freedom: Everyone should be free to pursue their livelihood. (Chaotic)"
        ],
        ["Loyalty",
            "Loyalty: When I make an ally, it's for life. (Any)"
        ],
        ["Nation",
            "Nation: My city, kingdom, and its people are all that matter. (Any)"
        ],
    ], //required; A list of the  ideals that can be chosen using the "Add Features" button on the second page. This list can be any length. Take note of the two-step build for every ideal, this is essential!

    bond : [
        "I'm trying to pay off an old debt I owe to a generous benefactor.",
        "My ill-gotten gains go to support my family.",
        "Something important was taken from me, and I aim to steal it back.",
        "I will become the greatest thief that ever lived.",
        "I'm guilty of a terrible crime. I hope I can redeem myself for it.",
        "Someone I loved died because of a mistake I made. That will never happen again."
    ], //required; A list of the bonds that can be chosen using the "Add Features" button on the second page. This list can be any length.

    flaw : [
        "So long as the Companion burns over Elturel, there is still hope for Faerûn.",
        "My name and deeds will be immortalized in the songs of the Hellriders.",
        "I idolize the High Rider and dutifully follow their commands.",
        "I have a mighty steed that I prize above all others.",
        "I'm not the first Hellrider in my family, and I won't be the last.",
        "I have sworn the strict oaths of the Creed Resolute. I vow to uphold the laws of Elturgard, protect its citizens, and serve the greater good."
    ],  //required; A list of the bonds that can be chosen using the "Add Features" button on the second page. This list can be any length.

    extra : [
        "Select a Rank / Role",
        "Hoof / Knight",
        "Quarter / Standard Bearer",
        "Stallion / Under-Marshal",
        "Destrier / Marshal",
        "High Rider / Commander"
    ], //optional; the extra options the background gives on the first page of the sheet (in line Background at the top there are two drop-down menus). The first entry in this array is what is used for the mouseover text. If your background offers no extra features, simply delete this entry. Make sure that text you enter here fits into the field, or it won't look as good

  toolProfs: [
    [
      ["Gaming Set", "or a Musical Instrument"],
      1
    ]
  ],

    languageProfs : [1], // optional; this is an array of the language proficiencies gained. An entry can either be 1) a string that represents the language learned or 2) a number which is the number of language gained that can be chosen by the player

    lifestyle : "comfortable", //optional; sets the lifestyle of the sheet. Options are: "wretched", "squalid", "poor", "modest", "comfortable", "wealthy", or "aristocratic"
};

BackgroundFeatureList["respected rider"]={
    //description as stated by the source:"As a Hellrider, you are well-respected within Elturgard, and your heraldry is recognized throughout Faerûn. While in the Kingdom of Two Suns - encompassing Elturel, Triel, Scornubel, Soubar, and Berdusk - you can commandeer fresh mounts for you and your party. Typically, this occurs at outposts such as Windstream Lodge, but Hellriders and their companions are held in high regard and can resupply in any Elturgard settlement. Use the warhorse statistics for your mount and the riding horse statistics for those of your comrades. Hellriders traditionally operate within Elturgard, but on occasion the High Watcher or High Rider has sent Hellriders to other lands. Outside of the Elturgard, you can purchase non-exotic mounts from merchants sympathetic to the Hellriders at half price.",
    description: "I am well-respected within Elturgard, and recognized throughout Faerûn. Within Elturgard I can commandeer mounts. We can also resupply in Elturgard. I can use warhorse stats for mine and riding horse stats for my comrades. Outside of Elturgard, I can purchase non-exotic mounts from those sympathetic to the Hellriders at half price.", //this is to fit the sheet properly
    source: ["BGDiAHB:HR", 6], // source and page of the feature
};