Jump to content

The Sims 4 Community Library 2.3

   (5 reviews)

1 Screenshot

About This File

Wicked Whims by Turbodriver and MCCC by Deaderpool are not compatible with this API.

TS4CommunityLib.png.52d77626bd18ecb86125a0809532fa05.png

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.93.129.1030 and above

 

Features:

Spoiler

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:

Spoiler
  1. Download the API using the links at the bottom of this description
  2. Unpack the archive using your favorite archiving tool.
  3. Drag the files and folders to your The Sims 4 directory. So `mod_data` will be at `The Sims 4/Mods/mod_data` and the other files will be at `The Sims 4/Mods`. Overwrite All if asked!
  4. 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/mod_data
    The Sims 4/Mods/sims4communitylib.package
    The Sims 4/Mods/sims4communitylib.ts4script

 

FAQ:

Spoiler
  • 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):

Spoiler

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:

Spoiler

The changelog is kept up to date and is located here

Edited by ColonolNutty


What's New in Version 2.3   See changelog

Released

- Updated many of the `convert_to_vanilla` and `convert_from_vanilla` functions to be more reliable and not dependent on the values of the enums.
- Added `MARKETPLACE_FASHION_NAME` to CommonSimNameType
- The `CommonOutfitUtils.get_outfit_parts` and `CommonOutfitUtils.get_outfit_data` functions will no longer generate an outfit for a Sim if they do not have it. Instead empty data will be returned.
- Added a function to check if a trait is a ghost trait.
- Updated the `CommonObjectUtils` functions to be class methods
- `get_occult_sim_info` will now return the original `sim_info` as it specifies in the return type, instead of None.
- Added new utility `CommonRecipeUtils`
- Fixed an issue with the `CommonSimCraftingUtils` if a Recipe object was passed to it instead of an identifier.
- Added an optional callback to `CommonSimInventoryUtils.add_to_inventory` that will be invoked when an object is added to the inventory of a Sim.
- Added an Information Pie menu to S4CL that can be used by various mods (Comes with a phone variant as well!)
- Fixed an error that could occur when retrieving the object definition of objects that do not have a definition.
- Added more details to the exception that occurs when producing Whims. It now displays the id of the Whim so it can be found easier.
- When JSON files are being read and an exception occurs, more details are made available to indicate the name of the file failing to be read.
- Added a new event for Interaction Started

  • Like 4
  • Thanks 8
  • Agree 1
  • Merry Christmas! 1

User Feedback

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest

CrowleyAstray

   9 of 9 members found this review helpful 9 / 9 members

I had no problems with this at all - honestly, the only reason I write this review is to counteract the 1-star, as I feel like that is a troll account!

Link to review
SickBastard81

   3 of 3 members found this review helpful 3 / 3 members

This mod is essential, I really like how easy it is to use. ColNutty made a rock-solid mod.

Link to review
Flaxz

   2 of 2 members found this review helpful 2 / 2 members

Just to balance out the 1 star from the troll

Link to review
mariak1010

   0 of 14 members found this review helpful 0 / 14 members

downloading this mod broke my downloads folder. it won't open anymore.

Response from the author:

Define "broke my downloads folder", because this API does not make any modifications to the game and thus would not "break your downloads folder". Did you mean your mods folder?

  • Confused 3
Link to review
Krys1379

  

I was bummed when I couldn't find this. I enjoy playing with this mod. Game isn't the same without it. Thanks for all your hard work keeping this mod going!

Link to review


×
×
  • Create New...