0 of 0
About this mod
This framework allows for easy integration of dreams for your dragonborn. The rate of dreams is configurable via MCM among other things.
- Requirements
- Permissions and credits
- Changelogs
For Users
This framework currently brings a single dream along for users, if you want to try it out feel free to download it. Maybe try out Oblivion Vampire Nightmares for some more nightmares! Or stay normal and use the Base Dreams .
The MCM allows for globally setting a dream chance(10% default) and globally disabling effects, if you want purely textual output. Also it allows you to increase dream chances for longer sleeping and disabling sounds.
Newly added is filtering by tags and a blacklist if you need to disable specific dreams.
For new or inexperienced Modders
See the article here for how to create your first dream.
For Experienced Modders
The framework will automatically detect xml-files in the framework's folder.
Example-XML:
You would create an xml at Skyrim Special Edition\Data\skse\plugins\FISS\idrinth_dream_framework\MyModName\MyExampleDream.xml . Empty/Unused tags should be left out. Due to limitations of FISS, the xml MUST NOT be formatted nicely, extra spaces between tags will break it.
The following effects are currently provided by the mod and can be used without having to reimplement them:
For Translators
To translate a dream, you only have to replace the text-node's content and provide the new file as an overwrite of the original mod's file. No changes to esl or esp needed.
Future Plans
Need help and don't want to wait for a reply here? Discord
This framework currently brings a single dream along for users, if you want to try it out feel free to download it. Maybe try out Oblivion Vampire Nightmares for some more nightmares! Or stay normal and use the Base Dreams .
The MCM allows for globally setting a dream chance(10% default) and globally disabling effects, if you want purely textual output. Also it allows you to increase dream chances for longer sleeping and disabling sounds.
Newly added is filtering by tags and a blacklist if you need to disable specific dreams.
For new or inexperienced Modders
See the article here for how to create your first dream.
For Experienced Modders
The framework will automatically detect xml-files in the framework's folder.
Example-XML:
<fiss><Header><Version>1.2</Version><ModName>Idrinth's Dream Framework</ModName></Header><Data><perk_id></perk_id><perk_file></perk_file><werewolf_only>0</werewolf_only><vampire_only>0</vampire_only><race_id></race_id><race_file></race_file><text>You open your eyes and see yourself sleeping in a bed. You can't move and lie there as if you were dead. Scared and weirded out by this out of body experience you awake.</text><effect_id>0xD69</effect_id><effect_magnitude>10</effect_magnitude><effect_duration>3600</effect_duration><effect_file>IdrinthDreamFramework.esp</effect_file><faction_id></faction_id><faction_file></faction_file><faction_rank></faction_rank><sex></sex><follower_id></follower_id><follower_file></follower_file><location_id></location_id><location_file></location_file><quest_id></quest_id><quest_file></quest_file><quest_stage></quest_stage><quest_stage_completed></quest_stage_completed><sound_id></sound_id><sound_file></sound_file><item_id></item_id><item_file></item_file><item_worn_only></item_worn_only><once_only></once_only><required_effect_id></required_effect_id><required_effect_file></required_effect_file><actor_value_name>Smithing</actor_value_name><actor_value_min>50</actor_value_min><is_violent></is_violent><is_horror><is_horror><is_sexual></is_sexual><is_in_interior></is_in_interior><is_in_exterior></is_in_exterior><player_min_level></player_min_level><player_max_level></player_max_level><stress_gain_amount></stress_gain_amount><stress_loss_amount></stress_loss_amount></Data></fiss>
You would create an xml at Skyrim Special Edition\Data\skse\plugins\FISS\idrinth_dream_framework\MyModName\MyExampleDream.xml . Empty/Unused tags should be left out. Due to limitations of FISS, the xml MUST NOT be formatted nicely, extra spaces between tags will break it.
- Perk-ID:the local id of a required perk, for example 0x800 (optional)
- Perk-File: The name of the file containing the perk
- Werewolf-Only: set to 1 if this is a dream for werewolves
- Vampire-Only: set to 1 if this is a dream for vampires
- Race-ID: The local id of the race this is for (optional)
- Race-File: The name of the file the race is defined in
- Text: The text to display as dream
- Effect-ID: The local id of an effect to apply (optional), needs to be Fire&Forget targeting self
- Effect-File: The name of the file the effect is in
- Effect-Duration: The duration in seconds
- Effect-Magnitude: The effect's magnitude
- Faction-ID: The local id of the faction this is for (optional)
- Faction-File: The name of the file the faction is in
- Faction-Rank: -1=possible member, 0 and above is rank
- Sex: male, female or empty
- Follower-ID: The local id of the follower this is for (optional)
- Follower-File: The name of the file the follower is in
- Location-ID: The local id of the location this is for, do NOT use Tamriel under most circumstances (optional)
- Location-File: The name of the file the location is in
- Quest-ID: The local id of the quest this is for (optional)
- Quest-File: The name of the file the quest is in
- Quest-Stage: The integer-ID of the quest stage to check
- Quest-Stage-Completed: Set to 1 if the Quest-Stage has to be completed, set to 0 if it must not be completed
- Sound-ID: the local id of the sound to load
- Sound-File: the Filename of the modfile defining the sound
- Item-ID: the local id of any item that can be carried
- Item-File: the filename of the file defining the item
- Item-Worn-Only: Set to 1 to check if Armor is worn, doesn't work on other kinds of items
- Once-Only: Prevents this dream from being dreamed more than once if this is set to 1
- Required-Effect-ID: the local id of any item that can be carried
- Required-Effect-File: the filename of the file defining the item
- Actor-Value-Name: Name of the Actor Value, see Wiki for a List
- Actor-Value-Min: The minimum this value needs to be(excluding buffs, this is the base value)
- Is-Violent: Set to 1 if your dream is unusually violent
- Is-Horror: Set to 1 if your dream is unusually horrifiv
- Is-Sexual: Set to 1 if your dream is unusually sexual
- Is-In-Interior: Set to 1 if it should only be dreamed inside
- Is-In-Exterior: Set to 1 if it should only be dreamed outside
- Player-Min-Level: Minimum level, inclusive
- Player-Max-Level: Maximum level, included
- Stress-Gain-Amout: If Stress and Fear is loaded your total stress will be increased by this amount. Values between 1-10 are suggested
- Stress-Loss-Amout: If Stress and Fear is loaded your total stress will be decreased by this amount. Values between 1-10 are suggested.
The following effects are currently provided by the mod and can be used without having to reimplement them:
- Alchemy Reduction 0x813 Increase 0x810
- Alteration Reduction 0x830 Increase 0x82F
- Archery Reduction 0x80E Increase 0x811
- Block Reduction 0x815 Increase 0x816
- Conjuration Reduction 0x817 Increase 0x818
- Destruction Reduction 0x819 Increase 0x81A
- Enchanting Reduction 0x81B Increase 0x81C
- Heavy Armor Reduction 0x81D Increase 0x81E
- Illusion Reduction 0x81F Increase 0x820
- Light Armor Reduction 0x822 Increase 0x823
- Lockpicking Reduction 0x824 Increase 0x825
- One-Handed Reduction 0x826 Increase 0x827
- Pickpocket Reduction 0x828 Increase 0x829
- Restoration Reduction 0x82A Increase 0x82B
- Smithing Reduction 0x82C Increase 0x82D
- Sneak Reduction 0x812 Increase 0x80F
- Speechcraft Reduction 0xD69 Increase 0x821
- Two-Handed Reduction 0x82E Increase 0x814
For Translators
To translate a dream, you only have to replace the text-node's content and provide the new file as an overwrite of the original mod's file. No changes to esl or esp needed.
Future Plans
- Add more options to the MCM
Need help and don't want to wait for a reply here? Discord