https://github.com/sanjosolutions/sims4-mod-project-template

A mod project template for Sims 4 with automated building and support for versioning of the project files.
https://github.com/sanjosolutions/sims4-mod-project-template

Last synced: 4 days ago
JSON representation

A mod project template for Sims 4 with automated building and support for versioning of the project files.

• Host: GitHub
• URL: https://github.com/sanjosolutions/sims4-mod-project-template
• Owner: SanjoSolutions
• License: other
• Created: 2024-06-13T15:53:50.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-23T06:12:56.000Z (6 months ago)
• Last Synced: 2024-12-15T08:42:21.729Z (7 days ago)
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sims 4 Mod Project Template

This template comes with automated building. It supports versioning of all files.

## Dependencies

- This template is made for [Visual Studio Code](https://code.visualstudio.com/).

- [Sims 4 Mod Development Tools](https://github.com/SanjoSolutions/sims4-mod-development-tools?tab=readme-ov-file#sims-4-mod-development-tools) for compiling the Python scripts.

- The Visual Studio Code extension [Sims 4 Toolkit](https://github.com/SanjoSolutions/s4tk-vscode/releases/download/0.2.4-with-build-task-fix/s4tk-vscode-0.2.4-with-build-task-fix.vsix) for creating the mod package. The linked file includes a fix for running the build command with a task. After the file has been downloaded, it can be installed in Visual Studio Code by opening the "Extensions" side bar, clicking on the three dots, selecting "Install from VSIX..." and then selecting the downloaded file.

## Adjusting the template for your project

- Replace `` in all files with your author name.

- Replace `` in all files with your mod name.

- Rename the folder `src/code/Author_ModName` to `_` (with the placeholders replaced).

- It might be required to adjust the path to "sims4-mod-development-tools" in the file `.vscode/tasks.json`.

## Installing Python

- See [here](https://github.com/SanjoSolutions/sims4-modding-guide?tab=readme-ov-file#installing-python) for how to install an appropriate version of Python for Sims 4 mod development.

- How to select the Python interpreter in Visual Studio Code: Open the command palette, then search for the command "Python: Select Interpreter". Choose the interpreter for Sims4. If it's not in the list, you can select "Enter interpreter path..." -> "Find..." and the select the "python.exe" which is usually the path "~/anaconda3/envs/Sims4/python.exe" (on Windows).

## License

This template is released under a MIT-0 license (see LICENSE).

With this license you can license you project that is based on this template under any license.

You can also remove the LICENSE file.