The Sims 4 Community Library
Mod Introduction
An open source library with a focus on providing utilities and services to the larger Sims 4 modding community. Let's not reinvent the wheel!
Link to the modInstallation Guide
[left][/left]Welcome to The Sims 4 Community Library!
Description:
This is more of an API than a mod itself. By itself, it does not modify any aspect of The Sims 4 it simply makes writing mods using Python much easier and more accessible for those looking to create their own mods. Only install the library if you have installed a mod that requires it!
A Short List Of Current Features (Not all features are listed here!):
For a complete list of features and utilities, check out the documentation
- A vast library of Vanilla Tuning identifiers for easy retrieval
- Logging
- Exception Handling
- Custom Dialogs
- Custom Notifications
- Custom Interactions
- Custom Icons
- Event Handling (Creating, Dispatching, and Listening)
- Miscellaneous Utilities
- Manipulate Sims, Objects,. the Weather, the Terrain, the UI, and many more!
- Test Framework
- Write and run tests (Can be run from within the game)
To see the documentation for S4CL check out the docs!
To start creating mods using S4CL check out the template project!
Looking to install S4CL?
Follow the installation instructions below for details.
Looking for the Source Files?
Find them over in the repository here.
Changelog:
For a changelog of the most recent updates and additions, take a look at the releases page.
Installation:
- Download the latest zip archive from the releases page (It is the one with the version number in it Example: sims4communitylib.v0.0.0.zip) (Ignore the ones that contain Source Code in their name)
- Unpack the archive using your favorite archiving tool.
- Drag the files and folder to your The Sims 4/Mods 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!
- Keep in mind the ts4script file MUST be either top level (Directly in the Mods/<ts4script file> folder) or one folder deep (Mods/Blah/<ts4script file>). Any deeper and it will not work.
Requirements:
- Sims 4 Patch Version 1.90.358.1030 (High School Years) or above
- DLCs are NOT required, you only need to have an up to date game (Check the bottom of the main menu for your current version).
Planned Features:
- For a list of planned features, take a look at the repository.
Note for Modders:
- If you have ideas for additions to add or want one of the planned features sooner rather than later, I'm all ears! Let's work together to create a library that we all can use!
- To see the documentation for S4CL check out the docs!
What is the workflow for working with S4CL?
- Create a project based off of the Template Project
- Use the green button in the top right The Main Page to download this project as a zip file.
- In your project, create another directory called `S4CL`.
- Open the downloaded project and copy the `Scripts/sims4communitylib` folder itself into the `S4CL` folder we created in the previous step. The folder structure should then be: `<Your Project>/S4CL/sims4communitylib`
- Right click the `S4CL` folder -> Mark Directory as -> Sources Root
- The `S4CL` folder should turn a blue color and the `sims4communitylib` folder should look like a folder with a dot (In other words, it should NOT be blue).
- Your folder structure should look like this: `<Your Project>/S4CL/sims4communitylib` at this point.
- Ensure you list in the description of your mod a link to the github releases (You may even link a specific release to ensure compatibility.)
- Ensure you properly attribute S4CL and its author according to the license located at the bottom of this readme.
- In order to prevent users from accidentally installing multiple copies of S4CL into their Mods folder, it is preferred to redirect the users of your mod to download S4CL from either the github repository or releases pages instead of bundling it with your mod.
Copyright:
[quote]
The Sims 4 Community Library is licensed under the Creative Commons Attribution 4.0 International public license (CC BY 4.0).
https://creativecommons.org/licenses/by/4.0/
https://creativecommons.org/licenses/by/4.0/legalcode
Copyright (c) COLONOLNUTTY[/quote]
Description:
This is more of an API than a mod itself. By itself, it does not modify any aspect of The Sims 4 it simply makes writing mods using Python much easier and more accessible for those looking to create their own mods. Only install the library if you have installed a mod that requires it!
A Short List Of Current Features (Not all features are listed here!):
For a complete list of features and utilities, check out the documentation
- A vast library of Vanilla Tuning identifiers for easy retrieval
- Logging
- Exception Handling
- Custom Dialogs
- Custom Notifications
- Custom Interactions
- Custom Icons
- Event Handling (Creating, Dispatching, and Listening)
- Miscellaneous Utilities
- Manipulate Sims, Objects,. the Weather, the Terrain, the UI, and many more!
- Test Framework
- Write and run tests (Can be run from within the game)
To see the documentation for S4CL check out the docs!
To start creating mods using S4CL check out the template project!
Looking to install S4CL?
Follow the installation instructions below for details.
Looking for the Source Files?
Find them over in the repository here.
Changelog:
For a changelog of the most recent updates and additions, take a look at the releases page.
Installation:
- Download the latest zip archive from the releases page (It is the one with the version number in it Example: sims4communitylib.v0.0.0.zip) (Ignore the ones that contain Source Code in their name)
- Unpack the archive using your favorite archiving tool.
- Drag the files and folder to your The Sims 4/Mods 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!
- Keep in mind the ts4script file MUST be either top level (Directly in the Mods/<ts4script file> folder) or one folder deep (Mods/Blah/<ts4script file>). Any deeper and it will not work.
Requirements:
- Sims 4 Patch Version 1.90.358.1030 (High School Years) or above
- DLCs are NOT required, you only need to have an up to date game (Check the bottom of the main menu for your current version).
Planned Features:
- For a list of planned features, take a look at the repository.
Note for Modders:
- If you have ideas for additions to add or want one of the planned features sooner rather than later, I'm all ears! Let's work together to create a library that we all can use!
- To see the documentation for S4CL check out the docs!
What is the workflow for working with S4CL?
- Create a project based off of the Template Project
- Use the green button in the top right The Main Page to download this project as a zip file.
- In your project, create another directory called `S4CL`.
- Open the downloaded project and copy the `Scripts/sims4communitylib` folder itself into the `S4CL` folder we created in the previous step. The folder structure should then be: `<Your Project>/S4CL/sims4communitylib`
- Right click the `S4CL` folder -> Mark Directory as -> Sources Root
- The `S4CL` folder should turn a blue color and the `sims4communitylib` folder should look like a folder with a dot (In other words, it should NOT be blue).
- Your folder structure should look like this: `<Your Project>/S4CL/sims4communitylib` at this point.
- Ensure you list in the description of your mod a link to the github releases (You may even link a specific release to ensure compatibility.)
- Ensure you properly attribute S4CL and its author according to the license located at the bottom of this readme.
- In order to prevent users from accidentally installing multiple copies of S4CL into their Mods folder, it is preferred to redirect the users of your mod to download S4CL from either the github repository or releases pages instead of bundling it with your mod.
Copyright:
[quote]
The Sims 4 Community Library is licensed under the Creative Commons Attribution 4.0 International public license (CC BY 4.0).
https://creativecommons.org/licenses/by/4.0/
https://creativecommons.org/licenses/by/4.0/legalcode
Copyright (c) COLONOLNUTTY[/quote]
No comment
