Group / Rule Properties

Property names are case insensitive. If a property accepts multiple values as an array, you do not need to use the [ ] to denote an array if only entering a single value.

Filters

All rules must list, at least 1 record type, in the Types filter, either directly in the rule or via a group. All other filters are optional, but when using multiple filters record must match all.

Filters for Groups or Rules

These filters can be used when creating a rule or group.

Rule Only Filters

Rule Only - Field Matches

• If you use one of these filters, any record that doesn't contain that field will never match the rule.
• If field is single value, like Name then:
  • +/!: You can add a prefix to these to say if they must be included or excluded from filter, however all entries should be the same prefix.
• If field is list of multiple values, like Keywords then:
  • &/|/^ Operator: You can change the default operation using a prefix on the field name. Default is OR (|). Can set to And (&) or XOR (^).
  • +/!: You can add a prefix to these to say if they must be included or excluded from filter. If using AND (&) each can be different prefix.
• Include (+) and OR (|) prefixes are default so no need to enter them however, can be used for unforeseen cases where the value you want to enter may start with a prefix value. Like trying to enter a negative number ("+-123" to allowed -123).
• If matching against a field that accepts a string or Editor ID you can use regular expression to match, like EditorID filter. If used with exclude operator the ! goes before the first /, like in the 4th example below.
• - is same as ! prefix
• Just like other filters if you list multiple different fields, the record must match all.

Examples

"Matches": { "Keywords": "ArmorMaterialLeather" }

"Matches": { "&Keywords": [ "ArmorMaterialLeather", "ArmorMaterialHide", "!WAF_ClothingCloak" ] }

"Matches": { "Keywords": [ "!ArmorMaterialLeather", "!ArmorMaterialHide" ] }

"Matches": { "InventoryArt": "!/^(?!.*(?:(?:Book)|(?:Journal)|(?:Tome))).*((?:Note)|(?:Scroll)|(?:Paper)|(?:Map)|(?:Recipe)).*$/" }

Actions

• Merge
• Forward - Should be self only if also using merge, else will overwrite merge.
• Fill - Could be used to add / remove extra stuff post Merge/Forward.

                {
                "Types": "Ingestible",
                "FormID": "FAA:CookingAdventuresInSkyrim.esp",
                "Fill":
                {
                "Name" : "My Name for This",
                "Effects": [ null, { "effect": "002EE1:Update.esm" } ]
                }
                }
              

                    {
                    "types": "Outfit",
                    "Masters": "Dawnguard.esm",
                    "ForwardOptions": ["SelfMasterOnly"],
                    "Forward": { "Cloaks - Dawnguard.esp": "Items" }
                    }
                  

                    {
                    "types": [ "NPC" ],
                    "OnlyIfDefault": true,
                    "ForwardOptions": ["IndexedByField"],
                    "Forward": { "Items": [ "PrvtI_HeavyArmory.esp", "Immersive Weapons.esp" ] }
                    }
                  

                    {
                    "types": [ "NPC" ],
                    "OnlyIfDefault": true,
                    "ForwardOptions": "DefaultRandom",
                    "Forward": { "Items": [ "PrvtI_HeavyArmory.esp", "Immersive Weapons.esp" ] }
                    }
                  

                    {
                    "types": [ "Outfit" ],
                    "Masters": "Dawnguard.esm",
                    "ForwardOptions": "DefaultThenSelfMasterOnly",
                    "Forward": { "Items": [ "Unofficial Skyrim Modders Patch.esp", "Cloaks - Dawnguard.esp" ] }
                    }
                  

Groups

Group Properties

            [
            {
            "Types": "Faction",
            "Masters": "Skyrim.esm",
            "SingleMatch": true,
            "Rules": [
            {
            "FormID": [
            "000013:Skyrim.esm",
            "01C4ED:Skyrim.esm",
            ...
            ],
            "Fill": {
            "flags": [
            "IgnoreMurder",
            "IgnoreAssault",
            "IgnoreStealing",
            "IgnoreTrespass",
            "DoNotReportCrimesAgainstMembers",
            "IgnorePickpocket",
            "IgnoreWerewolf"
            ]
            }
            },
            {
            "FormID": [
            "01BCC0:Skyrim.esm",
            "025F95:Skyrim.esm",
            ...
            ],
            "Fill": {
            "flags": [
            "IgnoreMurder",
            "IgnoreAssault",
            "IgnoreStealing",
            "IgnoreTrespass",
            "IgnorePickpocket",
            "-IgnoreWerewolf"
            ]
            }
            }
            ]
            }
            ]
          

Debug / Trace Logging

                {
                "types": [ "NPC" ],
                "OnlyIfDefault": true,
                "ForwardOptions": "DefaultRandom",
                "Debug": true,
                "Forward": { "Items": [ "PrvtI_HeavyArmory.esp", "Immersive Weapons.esp" ] }
                }
              

1. Limit what is logged by either:
   • using FormKey filter on settings page of GSP in Synthesis to limit to logging a single record that is affected by bug,
   • or if FormKey not available the above Debug filter to only output logs for rule relevant to bug.
2. Then either attach as text file to GitHub issue,
   or if you using Nexus you must use spoiler tags.

Global - Synthesis Settings

Here is where global settings for GSP are.