Community Library for The Sims 4! Description: This is more of an API than the mod itself. It doesn't do anything by itself and is intended as a framework for other Sims 4 developers to use in their own codebases. Install the library only if you have installed a mod that requires it!
Russian translation by
Origamika :
Download (suitable for all versions - updated 10/28/2020)
Chinese translation by
Zoophx:
Download (1.73)
Documentation To start creating mods with S4CL, check out the
project template !
Requirements:- The Sims 4 Version at least 1.77.131.1030 (Cottage Living)
Changelog:
https://github.com/ColonolNutty/Sims4CommunityLibrary/releases
- Vanilla Tuning identifiers for:
- Buffs
- Interactions
- Relationship Bits
- Relationship Tracks
- Short-Term Relationship Bits
- Motives
- Many Others!
- Logging
- Log messages to a file
- Log custom exceptions
- Log the current stack trace, find out who or what is calling your functions!
- Useful when debugging code!
- Enable / Disable logs via a command in-game. `s4clib.enable_log < log_name >`
- Exception Handling
- Log to a file exceptions that are thrown
- Catch exceptions within your functions via a decorator
- Custom Dialogs
- Ok / Cancel Dialog
- Choose Object Dialog
- Choose Sim Dialog
- Custom Icons:
- Right Arrow
- Navigate Into Arrow
- Question Mark
- Six Sided Dice
- Checked Box
- Unchecked Box
- Notifications
- Sim Icons
- Warnings
- Errors
- Info
- Story Dialogs (Add custom buttons, add sim icons)
- Sim Picker
- Prompt the player to choose a sim or a number of sims from a dialog.
- Custom Notifications
- Basic Notification - Display a notification with a title and description of varying urgency.
- Interactions
- Registration
- Register Interactions to:
- Terrain
- Ocean
- Objects (Sims, Furniture, etc.)
- Custom Interactions
- Create interactions the run Python code in their backends
- Interaction Types:
- CommonInteraction - Inherit from this to hook into an interaction and add python functionality to its functions
- Immediate Super Interaction - An interaction that doesn't require a target to perform. It is started immediately and without an animation.
- Super Interaction - Like the Immediate Super interaction but these require a target to perform. (sim_chat is one example of a Super Interaction)
- Mixer Interaction - Use this for custom Mixer interactions.
- Social Mixer Interaction - Use this for custom Social Mixer interactions.
- Terrain Interaction - Use for interactions that appear when clicking on the ground.
- Perform logical checks to determine whether or not to show an interaction
- Or display an interaction as disabled, with a displayed tooltip that shows when the player hovers the interaction.
- Run Python code when an interaction is started, cancelled, or has finished.
- Custom Interaction Tooltips
- Display tooltips on interactions that display on hover.
- Locate CommonInteraction for an example of how to utilize custom tooltips in your own interactions.
- Event Handling
- Create, Dispatch, and Handle Dynamic Events
- Handle events without needing a reference to the code that sends the event.
- Decouple that code!
- Interval Events
- Run functions on millisecond intervals.
- Run functions once, after an amount of time has passed.
- Interaction events (Queued, Started, Ended, Interaction Outcomes)
- Sim
- Spawn - Occurs when a Sim spawns or is born into the world.
- Initialization - Occurs when a Sim is initialized (before being spawned).
- Occult Swapping - Occurs when a Sim changes to a different Occult (i.e. Human to Mermaid or Human to Vampire or vice verse)
- Zone Events
- Zone Update - Occurs every time the zone updates. (Basically every time the game ticks)
- Zone Teardown - Occurs every time the zone is torn down. Occurs before a loading screen, but only after a Zone had been previously loaded. (See Zone Early/Late Load)
- Zone Save - Occurs every time a zone is saved. This occurs before the game saves for the player. Be careful with this one!
- Zone Early Load - Occurs when a zone is loaded, but before the players household has loaded.
- Zone Late Load - Occurs when a zone is loaded, but after the players household has loaded.
- Utilities
- Sim utilities
- Get the Active Sim
- Get Sim Info, Sim Instance, and Sim Ids
- Get All Sims nearby and filter which types of sims to get (Age, Species, Occult, Traits, Buffs, etc.)
- Occults - Check Occult Types of sims.
- Ages - Get/Set/Check Ages of sims.
- Genders - Get/Set/Check Genders of sims.
- Species - Get/Set/Check Species of sims.
- Buffs - Add/Remove/Check Buffs of sims.
- Traits - Add/Remove/Check Traits of sims.
- Sim State - Check various states of sims. (Wearing towel, Dying, etc.)
- Sim Spawn/Despawn - Spawn, Despawn, and Delete Sims.
- CAS
- Outfit - Set/Get/Update/Check the current outfit of sims.
- CAS Utils - Attach/Detach/Check cas parts of a sims outfit. You can put any cas part in any BodyType via these.
- Components - Get various components of objects (Statistics, Traits, Buffs, etc.)
- Resources - Load Resources or Tuning files by their identifiers. (Buffs, Traits, Statistics, Snippets, etc.)
- Icons - Load Icons provided by S4CL or your own Icons.
- Types - Determine the type of objects without needing to use isinstance or having a reference to the type itself in your own code.
- Time - Manage time. Pause the game, get/change the current game speed, get/set the time of day, etc.
- Collections - Determine if an object is a collection, combine collections, flatten collections, etc.
- Injection - Inject custom functionality into functions
- IO (Input/Output) - Write string data to a file or load string data from a file.
- Stack Trace - Retrieve the complete and full stack trace.
- Localization utilities
- Retrieve LocalizedStrings from StringTables of .package files.
- Format tokens into LocalizedStrings
- Display text in specific colors (Colors can be added by request)
- Blue
- Green
- Red
- Create Localized Tooltips - Use to display tooltips on interactions (while also displaying the interaction)
- These can be useful to give more information to the player about why something cannot be performed, instead of simply hiding that something.
- Weather
- Statistics
- Motives
- Many more!
- Testing Framework
- Write tests to test your python code and run the tests via a command within the game.
- The results will be logged to the 'Documents/The Sims 4/' folder
- A single function can handle multiple tests utilizing the same code with different arguments.
- Run tests via the command: `s4clib.run_tests <class_names_separated_by_a_space>`
- Class Names are the names of the classes decorated with 'test_class'
- If no class names are provided, all of the tests will run.
- Download the latest zip archive above.
- Unpack the archive using your favorite archiving tool.
- Drag files / folders to Mods directory.
- Keep in mind that the ts4script file must be either a top level (directly in the Mods / <
ts4script file > folder) or one deep folder (Mods / Blah / <
ts4script file>). Even deeper, and nothing will come of it.
!!!Alert!!!
To those using this mod, if you are told that my mods do any of the following:
- Will break or cause severe issues within your game
- Contain themes endangering or abusing Children
- Contain themes endangering or abusing Animals
- Contains illegal content
Please know that ALL of this is misinformation, and completely false.
The mod authors known as TURBODRIVER and Deaderpool have chosen to Stalk, Target, and Cyberbully me and anyone who chooses to use any of my mods. They have chosen to spread misinformation (slander) about my mods for years, and have gone so far as to put malicious code in Wicked Whims targeting my mods (and by extension those who make mods using S4CL which is a fairly large chunk of mod authors). I believe in creating mods that better the community as a whole, even if I have no personal interest in the criteria of the mod itself. Even the API called Sims 4 Community Library, which I have created for new and old mod authors to create simpler and more stable mods while also providing a vast store of functionality for said mods, has been targeted by these mod authors. They go on witch hunts, banning or threatening anyone who dares join my discord. They have threatened other mod authors, discords, websites, and various other forms of media into also banning and threatening people for using my mods.
Sadly, this has put me in a place where the very community I love and support, slanders me and continues to spread the same misinformation, without knowing that many of the negative things being said have zero evidence to back them and are nothing more than cyberbullying.
Though these Mod Authors are extremely successful, they have been using their popularity to ruin my reputation and railroad the community into believing these lies. This has caused many discords to ban people for using any of my mods and it has turned my name into something that frightens everyone when it is even mentioned. I try my best to support and create content for this community out of my own pocket and this is completely unacceptable.
Please do not believe everything you read on the internet. There's always two sides
to a story but above all there is the absolute truth. Its up to us as people to find it out
and refrain from hopping onto bandwagons stirred up by popular mod authors.
I love this community, and despite what TURBODRIVER and Deaderpool say to ruin me, I will continue doing my best to support this community, noone deserves this treatment, especially not someone who makes mods for free.
Previous versions: There is not really a reason to use an older version. S4CL is always and will always be backwards compatible.
Метки:
Программы; моддинг; инструменты, Фиксы; исправления
