Give Feedback
0 of 0
About this mod
Limit the amount of events seen in a day or in a row to increase story immersion.
- Requirements
- Permissions and credits
- Changelogs
Event Limiter
Event Limiter allows for the configurable limitation of the amount of events seen by the player each day, and in a row. This can help with storyline immersion or in multiplayer where time continues during events.
By default, events are limited to 4 per day, and 2 in a row. Exempt events will also contribute to the event limits by default.
Skipped events will be played the next time they will trigger, provided an event limit has not been reached. Hardcoded events (weddings) and PlayerKilled events won't be skipped and won't be counted as a seen event for the purposes of limiting events.
Exclusions to which events are affected can also be configured. If there's a cutscene you never want skipped this can be done by listing its id in the Exceptions config option. As of version 1.2.1, event exceptions can optionally be excluded from contributing to event limits, similar to hardcoded events. Simply set ExemptEventsCountTowardsLimit to false in the config.
The mod supports Generic Mod Config Menu for changing event preferences as of version 1.1.0. Long exception lists will extend past the textbox in the menu but will be implemented properly. Square brackets and double quotation marks are not required when editing the exceptions in the config menu.
As of version 1.2.0, Content Patcher integration and an api has been added to allow Content Patcher content packs and SMAPI mods to add there own event limit exceptions, and allow SMAPI mods to access some mod data. More information is available in the README on Github.
The mod does use Harmony, just FYI.
Installation and use:
Editing the config:
When editing the config, enter only numbers (do not put quotation marks around the numbers).
EventsPerDay sets how many events will be seen per day.
EventsInARow sets how many events will be seen in a row when entering a new location.
ExemptEventsCountTowardsLimit determines whether event exceptions will contribute towards the event limits when seen. Default is true.
Exceptions is a list of event ids (each enclosed in double quotation marks) the mod should not skip even if a limit is reached. It is in the form of a comma seperated list, enclosed in square brackets e.g ["1","2","3"]. Event Limiter will still recognise ids without double quotation marks surrounding them (pre 1.6), but this will likely break in the future. It is recommended to update the config accordingly. If using GMCM, double quotation marks aren't needed and the mod will correct the entries for you.
While negative numbers can technically be entered in the config, the mod will treat these numbers as 0.
If the mod is unable to read the config, default values will be used.
Compatibility:
- Requires SMAPI version 4.0 or above
- Compatible with multiplayer, each player can have different event preferences.
- Compatible with split-screen, event preferences are shared between players.
See also:
- Source code
Event Limiter allows for the configurable limitation of the amount of events seen by the player each day, and in a row. This can help with storyline immersion or in multiplayer where time continues during events.
By default, events are limited to 4 per day, and 2 in a row. Exempt events will also contribute to the event limits by default.
Skipped events will be played the next time they will trigger, provided an event limit has not been reached. Hardcoded events (weddings) and PlayerKilled events won't be skipped and won't be counted as a seen event for the purposes of limiting events.
Exclusions to which events are affected can also be configured. If there's a cutscene you never want skipped this can be done by listing its id in the Exceptions config option. As of version 1.2.1, event exceptions can optionally be excluded from contributing to event limits, similar to hardcoded events. Simply set ExemptEventsCountTowardsLimit to false in the config.
The mod supports Generic Mod Config Menu for changing event preferences as of version 1.1.0. Long exception lists will extend past the textbox in the menu but will be implemented properly. Square brackets and double quotation marks are not required when editing the exceptions in the config menu.
As of version 1.2.0, Content Patcher integration and an api has been added to allow Content Patcher content packs and SMAPI mods to add there own event limit exceptions, and allow SMAPI mods to access some mod data. More information is available in the README on Github.
The mod does use Harmony, just FYI.
Installation and use:
- Download to mod
- Unzip the download file and place the EventLimiter folder in your Mods folder
- Run the game at least once to generate the config
- Edit the config as desired and enjoy!
Editing the config:
When editing the config, enter only numbers (do not put quotation marks around the numbers).
EventsPerDay sets how many events will be seen per day.
EventsInARow sets how many events will be seen in a row when entering a new location.
ExemptEventsCountTowardsLimit determines whether event exceptions will contribute towards the event limits when seen. Default is true.
Exceptions is a list of event ids (each enclosed in double quotation marks) the mod should not skip even if a limit is reached. It is in the form of a comma seperated list, enclosed in square brackets e.g ["1","2","3"]. Event Limiter will still recognise ids without double quotation marks surrounding them (pre 1.6), but this will likely break in the future. It is recommended to update the config accordingly. If using GMCM, double quotation marks aren't needed and the mod will correct the entries for you.
While negative numbers can technically be entered in the config, the mod will treat these numbers as 0.
If the mod is unable to read the config, default values will be used.
Compatibility:
- Requires SMAPI version 4.0 or above
- Compatible with multiplayer, each player can have different event preferences.
- Compatible with split-screen, event preferences are shared between players.
See also:
- Source code