Mod: Unlock Blueprints: Difference between revisions
More actions
Bonsaibauer (talk | contribs) Create English ShroudForge Wiki article |
Bonsaibauer (talk | contribs) Marked this version for translation |
||
| Line 10: | Line 10: | ||
<translate> | <translate> | ||
<!--T:1--> | |||
SF Unlock Blueprints is a ShroudForge mod that changes the unlock requirements stored on Enshrouded recipes. Its package ID is <code>sf-unlock-blueprints</code>, and the current package version is <code>1.0.2</code>. | SF Unlock Blueprints is a ShroudForge mod that changes the unlock requirements stored on Enshrouded recipes. Its package ID is <code>sf-unlock-blueprints</code>, and the current package version is <code>1.0.2</code>. | ||
<!--T:2--> | |||
The package is disabled by default. It targets the client and Dedicated Server and requests the <code>patch</code> capability. It does not request the Lua <code>runtime</code> capability and has no player-facing settings. | The package is disabled by default. It targets the client and Dedicated Server and requests the <code>patch</code> capability. It does not request the Lua <code>runtime</code> capability and has no player-facing settings. | ||
== What the mod changes == | == What the mod changes == <!--T:3--> | ||
<!--T:4--> | |||
During ShroudForge's pregame asset-preparation pass, the mod reads the game's named knowledge query <code>Unlock_Flame_Altar_PK</code> and resolves the knowledge ID used by its <code>NPC_Flame_Hint01</code> action. It does not assume that this ID is a universal constant. | During ShroudForge's pregame asset-preparation pass, the mod reads the game's named knowledge query <code>Unlock_Flame_Altar_PK</code> and resolves the knowledge ID used by its <code>NPC_Flame_Hint01</code> action. It does not assume that this ID is a universal constant. | ||
<!--T:5--> | |||
The mod then scans the loaded <code>keen::RecipeRegistryResource</code> assets. For each recipe with a knowledge requirement, it sets that requirement to the resolved Flame Altar hint and normalizes the requirement to a simple Boolean equality check. Recipes without a knowledge requirement are left alone. The package does not change recipe ingredients, outputs, production times, or recipes that have no unlock requirement. | The mod then scans the loaded <code>keen::RecipeRegistryResource</code> assets. For each recipe with a knowledge requirement, it sets that requirement to the resolved Flame Altar hint and normalizes the requirement to a simple Boolean equality check. Recipes without a knowledge requirement are left alone. The package does not change recipe ingredients, outputs, production times, or recipes that have no unlock requirement. | ||
<!--T:6--> | |||
The change takes effect after the game starts with the mod enabled. If ShroudForge finds no recipe registries, it reports a warning. If registries are present but no recipe needs a change, it reports that result. Otherwise, it logs the number of changed recipes and registries. | The change takes effect after the game starts with the mod enabled. If ShroudForge finds no recipe registries, it reports a warning. If registries are present but no recipe needs a change, it reports that result. Otherwise, it logs the number of changed recipes and registries. | ||
== Enable the mod == | == Enable the mod == <!--T:7--> | ||
<!--T:8--> | |||
# Install the <code>sf-unlock-blueprints</code> package in the ShroudForge mods directory for the process that loads the world. | # Install the <code>sf-unlock-blueprints</code> package in the ShroudForge mods directory for the process that loads the world. | ||
# Open the ShroudForge Mods window and enable SF Unlock Blueprints. | # Open the ShroudForge Mods window and enable SF Unlock Blueprints. | ||
| Line 29: | Line 35: | ||
# Check the ShroudForge log if the expected recipes remain locked. Look for the package's registry and changed-recipe messages. | # Check the ShroudForge log if the expected recipes remain locked. Look for the package's registry and changed-recipe messages. | ||
<!--T:9--> | |||
The package uses the <code>patch</code> capability to alter game asset data before normal gameplay. If that capability is unavailable, the mod stops with an error instead of continuing without applying its change. | The package uses the <code>patch</code> capability to alter game asset data before normal gameplay. If that capability is unavailable, the mod stops with an error instead of continuing without applying its change. | ||
== Reverting the change == | == Reverting the change == <!--T:10--> | ||
<!--T:11--> | |||
The package manifest warns that reverting this change requires resetting all affected blueprint unlock progress. Do not disable the mod in an existing world unless you are prepared to reset that progress. Back up the world and review the current package release before changing the mod's state. | The package manifest warns that reverting this change requires resetting all affected blueprint unlock progress. Do not disable the mod in an existing world unless you are prepared to reset that progress. Back up the world and review the current package release before changing the mod's state. | ||
== Package details == | == Package details == <!--T:12--> | ||
<!--T:13--> | |||
{| class="wikitable" | {| class="wikitable" | ||
! Field !! Value | ! Field !! Value | ||
| Line 55: | Line 64: | ||
|} | |} | ||
<!--T:14--> | |||
This page describes the current package source. It replaces older GitHub Pages wording that marked SF Unlock Blueprints as a removed historical package. | This page describes the current package source. It replaces older GitHub Pages wording that marked SF Unlock Blueprints as a removed historical package. | ||
Latest revision as of 00:15, 18 November 2026
SF Unlock Blueprints is a ShroudForge mod that changes the unlock requirements stored on Enshrouded recipes. Its package ID is sf-unlock-blueprints, and the current package version is 1.0.2.
The package is disabled by default. It targets the client and Dedicated Server and requests the patch capability. It does not request the Lua runtime capability and has no player-facing settings.
What the mod changes
During ShroudForge's pregame asset-preparation pass, the mod reads the game's named knowledge query Unlock_Flame_Altar_PK and resolves the knowledge ID used by its NPC_Flame_Hint01 action. It does not assume that this ID is a universal constant.
The mod then scans the loaded keen::RecipeRegistryResource assets. For each recipe with a knowledge requirement, it sets that requirement to the resolved Flame Altar hint and normalizes the requirement to a simple Boolean equality check. Recipes without a knowledge requirement are left alone. The package does not change recipe ingredients, outputs, production times, or recipes that have no unlock requirement.
The change takes effect after the game starts with the mod enabled. If ShroudForge finds no recipe registries, it reports a warning. If registries are present but no recipe needs a change, it reports that result. Otherwise, it logs the number of changed recipes and registries.
Enable the mod
- Install the
sf-unlock-blueprintspackage in the ShroudForge mods directory for the process that loads the world. - Open the ShroudForge Mods window and enable SF Unlock Blueprints.
- Restart Enshrouded so the pregame asset-preparation pass can update recipe requirements.
- Check the ShroudForge log if the expected recipes remain locked. Look for the package's registry and changed-recipe messages.
The package uses the patch capability to alter game asset data before normal gameplay. If that capability is unavailable, the mod stops with an error instead of continuing without applying its change.
Reverting the change
The package manifest warns that reverting this change requires resetting all affected blueprint unlock progress. Do not disable the mod in an existing world unless you are prepared to reset that progress. Back up the world and review the current package release before changing the mod's state.
Package details
| Field | Value |
|---|---|
| Package ID | sf-unlock-blueprints
|
| Version | 1.0.2
|
| Targets | Client and Dedicated Server |
| Capability | patch
|
| Dependencies | None |
| Default mod state | Disabled |
| Player-facing settings | None |
This page describes the current package source. It replaces older GitHub Pages wording that marked SF Unlock Blueprints as a removed historical package.