Jump to content

1 Screenshot

About This File

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 - Discord (Pre Release Builds Available There)
Language: English
Game Version:  1.115.253.1020 (Businesses & Hobbies) 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. The 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/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 3.17   See changelog

Released

- Added a fix for broken relationship tracks in EA
- Added new test set instance tests for checking career levels between two Sims
- Added an option to hide tooltips for CommonTest
- Added an event for when a Sim is Changing ages but has not changed ages yet.
- Added a command to set fame level of a Sim
- Fixed some issues when using CommonBodySlot with CommonCASUtils functions
- Added a function to combine loot actions to CommonLootActionsUtils
- When creating a household after not finding one via locate_household_by_name, if create_on_missing is true, the name of the created household will now be the one sent in.
- Added a function to retrieve the first career of a Sim in CommonSimCareerUtils
- Fixed the s4clib.remove_simoleons command, it now actually removes the specified simoleons, instead of adding them.
- Added functions to determine the toilet sitting and standing traits used for a Sim's species in CommonSimGenderOptionUtils
- Added functions to check if a Sim has a father, mother, grandmother, and grandfather in CommonSimGenealogyUtils
- Added a function to check if a Sim has blood related children to CommonSimGenealogyUtils
- Added a function to get all children of a Sim to CommonSimGenealogyUtils
- Added a function to check if a Sim is instanced to CommonSimUtils

  • Like 9
  • Thanks 9
  • Haha 1
  • Agree 1
  • Merry Christmas! 1
  • Yes! 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

   11 of 11 members found this review helpful 11 / 11 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!

  • Like 1
SickBastard81

   4 of 4 members found this review helpful 4 / 4 members

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

  • Like 1
Krys1379

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

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!

  • Like 1
Flaxz

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

Just to balance out the 1 star from the troll

  • Like 1
mariak1010

   0 of 18 members found this review helpful 0 / 18 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


×
×
  • Create New...