About This File
The Sims 4 Community Library
Overview:
An API, for The Sims 4, used to make creating/writing mods using Python much easier and more accessible. On its own it does only a few debug commands/interactions. Only install this API if you also have a mod installed that requires it! This mod is intended to always be backwards compatible, so it is recommended to always keep it up to date!
Game/Creator: The Sims 4 [EA]
Modder: ColonolNutty - Documentation - Github Wiki - Wiki - Discord (Pre Release Builds Available There)
Language: English
Game Version: 1.103.250.1020 (For Rent) and above
Features:
A Short List Of Current Features (Not all utilities are listed here because they are waaay too numerous!):
For a complete list of features and utilities, check out the documentation at the top of this description!
- A vast library of Vanilla Tuning identifiers for easy retrieval (Enums)
- Logging
- Exception Handling
-
Custom Dialogs
- Choose Dialogs, Outfit Dialog, Purchase Dialogs, and more!
- Custom Notifications
- Custom Interactions
- Custom Icons
-
Event Handling (Creating, Dispatching, and Listening)
- Dispatching of Vanilla Events, such as Age Changes, Traits Added/Removed, Buffs Added/Removed, and more!
-
Miscellaneous Utilities
- Manipulate Sims, Objects,. the Weather, the Terrain, the UI, and many more!
- Manipulate Sim Voices, Households, Gender Options, Genders, Situation States, Object Repair States,
-
Test Framework
- Write and run tests (Can be run from within the game)
- There are a TON more features not listed here! You may see all utilities/classes available to you at the Documentation link at the top of this description!
Installation:
- Download the API using the links at the bottom of this description
- Unpack the archive using your favorite archiving tool.
- Drag the files and folders to your The Sims 4 directory. The files will be at `The Sims 4/Mods`. Overwrite All if asked!
-
Keep in mind the ts4script file MUST be either top level (Directly in the Mods/folder) or one folder deep (Mods/Blah/). Any deeper and it will not work.
The final paths for the files should be the following:
The Sims 4/Mods/sims4communitylib.package
The Sims 4/Mods/sims4communitylib.ts4script
FAQ:
-
Q: S4CL is throwing a ton of errors in my game! Can you fix it??
- A: S4CL can catch errors caused by other mods. It is extremely rare that S4CL itself is the one breaking.
-
Q: Is S4CL compatible with X???
- A: S4CL is compatible with ALL mods, it is intended to be an extension of The Sims 4 and not replace functionality of it.
-
Q: I don't want to use S4CL because it contains Adult Content!!
- A: S4CL does not contain any adult content whatsoever. It may be available on Sites that permit Adult Content, however it does contain any adult content itself.
Translations:
Usage (For Mod Authors):
A nifty tutorial has been created on the Github Wiki to help those wishing to either get into modding The Sims 4 or to begin utilizing S4CL, you may find it here
Change-Log:
The changelog is kept up to date and is located here
Edited by ColonolNutty
What's New in Version 1.80 See changelog
Released
- Added an entire item query system. It can be used to quickly setup a library of objects that can be queried.
- Added a serializable cache system. It can be used to quickly setup a caching system.
- Added an invidual folder persistence service.
- Added a vanilla fix for missing postures when Sims attempt to perform interactions.
- Added a vanilla fix for missing recipes when a recipe to make an object is removed, but the object itself still exists on the lot.
- Added classes used to store setting data as well as access Settings.
- Added CommonRunnable and CommonRunnableContext classes. These can be used to quickly setup an instance that will run over a period of time. It handles setup, updates, and teardown of it as well.
- Added new utility CommonSimDemographicTypeUtils
- Added new enum CommonSimDemographicTypes
- Added new dialog CommonChooseSimDemographicTypesDialog
- Added new enum types CommonVersionedInt and CommonVersionedIntFlags
- Fixed an issue when saving the CommonSerializableObjectCache when the folder paths do not exist. It will now properly create all directories that lead to the cache save location.
- Added a new function to apply pressure to the next interaction of a Sim. (CommonSimInteractionUtils)
- Added an assertion to catch when a None location is sent to the CommonObjectSpawnUtils.spawn_object_near_location function
- Updated many of the CommonSimGenderPreferenceUtils for the latest High School DLC patch.
- Added commands to apply the default gender preferences to all Sims or a single Sim. `s4clib.apply_default_gender_pref_to_all_sims` and `s4clib.apply_default_gender_pref`
- Fixed a couple errors caused by the high school DLC patch
