Core Library
About Core Library
For Players
Core Library is a dependancy for many mods to add gameplay functionality without overriding each other. It helps reduce conflicts and the need for redundant scripts.
For Creators
Core Library includes reusable snippets to perform common tuning injections and add other functionality to your tuning only mods without the need for you to script.
If you are developing your own scripts you can use Core Library to easily setup loggers, config files, or even game services. An event system is included so you can run code on zone load and unload and many other events without adding additional injection points that could otherwise cause conflicts with other mods.
Players: Received an exception using Core Library? Trying to find a conflict?
Core Library does not do anything on its own. If you are experiencing an issue in game and it goes away when removing Core Library then you need to keep the library installed and 50/50 the other mods.
Please contact the creator of those mods to report the issue. If there is an issue with library itself then the creator can contact me.
Installation Notes
Unzip and place the ts4script in your Mods folder. Make sure you only have ONE copy at a time.
Double check that your unzipped script does not end with a number in the case your destination folder had an existing file with the name — otherwise the script will not load.
If you organize your CC, make sure scripts are not placed more than one folder deep.
Get Mod Support with Bot 51
You can can now get automated mod support directly online!
Open Bot 51 in the lower right corner of your screen then ask a question or upload a Last Exception file or Lot 51 log file like lot51_core.log.
If you need human support you will need to Join the Discord community.
You can upload 5 files and ask 20 questions per day.
Core Library Documentation
Tuning Injector Snippet
Inject to Interactions, Traits, Buffs, even Social Bunny without any scripting. There are many things you can do with this one snippet! View the TDESC for detailed information. Open in Tuning Builder
Purchase Picker Snippet
This is an advanced snippet to create Purchase Pickers with stock management + discounts, and can generate rows from definitions, tags, or recipes! Open in Tuning Builder
LotFiftyOneCoreLootActions Tuning
A set of custom loot actions that provide new functionality, or more advanced alternatives to EA loot actions. This includes opening a PurchasePickerSnippet above. Open in Tuning Builder
Affordance Lock Out Snippet
A snippet to provide lockout functionality to SuperInteractions similar to Mixers. Once a Sim runs an interaction either autonomously or user-directed, the interaction will not be allowed to run for the interval provided. Open in Tuning Builder
Clear Mod Save Data Commands (1.34+)
Some mods (like Suite Life) may use the Core Library Save Based Config system which stores data in a household allowing it to be carried and modified per-save. You can use the following commands to purge that data and start fresh.
PSA: In-Game Pack Selection Feature
If the new Pack Selection feature is used, you MUST restart your game to get it back in a safe state for Core Library to run. Some changes will say you don't need a restart, but do it anyway.
Core Library 1.43
- The tuning reload system triggered by the Pack Selector is now triggered each time the game loads your purchased marketplace content, meaning restarting the game no longer makes this "issue" go away.
- The library will no longer be disabled when tuning reloads and won't see the notification anymore. May the sim lords have mercy on your game.
Core Library 1.42
- Added `inject_to_venues`, `inject_to_zone_directors` injectors to the TuningInjector.
- Added affordance_links and affordance_lists injections to affordance basic content that use flexible length staging content.
Core Library 1.41
- Added
inject_to_dynasty_valuesandinject_to_zone_modifiersto the TuningInjector.
Core Library 1.40.1
- 1.40.1: Reroll to include PlumBuddy manifest
- Improved FlagStatInteraction; This update is required to use the new Plum Telephone Company.
Core Library 1.39
- Fixes an exception when opening a Sim Picker and a sim has a custom CC career with a 64 bit ID.
- This affects Suite Life, PlumbBros and Simzlink
- This only affects players with Royalty & Legacy installed/enabled.
- This fix applies to all custom careers, not just mine!
The Royalty & Legacy patch introduced a new Noble Career Sim Filter to every Sim Picker in the game. This causes the sim's career IDs to be sent to the UI and was made to only support 32 bit IDs. This patch just yeets 64 bit careers before sending to the UI
I don't see this feature being used often for custom careers, so it should be safe for this hotfix to stay in place. It is unrealistic to expect every creator to change their careers to 32 bit unless they want to use this feature. It would probably cause more havoc by changing them and then the old careers disappear from every sim with those careers.
Core Library 1.38
- Fixed exception/crash related to a change in Portals in the Royalty & Legacy patch affecting Suite Life elevators.
- This fix is backwards compatible with older game versions.
Pagination
lot51_core.open_url <url> [params]
Opens a URL in the Player's default browser. Params (optional) can be a stringified JSON object with additional url query params.
purchase_picker.refresh <id>
Forces a refresh of the available stock in a PurchasePickerSnippet that has stock_management enabled.