Skip to content
Xientra edited this page Jan 19, 2024 · 2 revisions

Welcome to the The-Sims-Resource-Downloader wiki!

Full Usage Guide (Windows)

Installing Python

Go to https://www.python.org/ and download Python Version 3.8 or higher.

The installer will have an option reading something along the lines of "Add Python 3.8 to PATH", make sure this option is checked, otherwise you may run into issues.

Setting Up The Tool

Download the latest release from here: Latest (release) and extract it.

Open up the folder and open up a terminal, you can type cmd into folder path, and it should open a cmd in the current directory, or you can hold the shift key and right click, and you should have the option to open PowerShell.

If, for some reason, the path to the folder isn't correct, you can type cd <your desired location here>, should look something like cd C:\Users\Xientra\Downloads\The-Sims-Resource-Downloader-0.4.1 to change the directory manually.

Once you have a terminal open, it is recommended to install the dependencies into an environment instead of globally. To create an environment, run the following command:

python -m venv venv

Once an environment has been made, run the following command to load the environment, this command will need to be executed in any new terminal before using this tool:

venv\Scripts\activate.bat

Then run the following command to install the needed dependencies:

pip install -r requirements.txt

After the dependencies have installed, run the following command to start the tool:

python src/main.py

Configuring The Tool

To configure settings for the tool, open up the config.json file in the src folder.

Option Description type
downloadDirectory Path to a directory where the files will be downloaded to. string
maxActiveDownloads Limits the amount of concurrent downloads. integer
saveDownloadQueue Toggles saving & loading of active downloads & queued downloads. boolean
debug Toggles debug messages from the logger. boolean

Common Issues

json.decoder.JSONDecodeError: Invalid \escape

Check your config.json file and change the downloadDirectory option, which will look something similar to C:\Your\Location\To\Download\To. You will need to double up the backslashes, and now it should look something like C:\\Your\\Location\To\\Download\\To. Save the file and run the tool again.

Using The Tool

Simply browse The Sims Resource and copy the URL of any item you wish to download, the tool with automatically recognize the URL from your clipboard and starts downloading it.

Recommendations For Browsing The Sims Resource

It is highly recommended to use an ad blocker to browse The Sims Resource, such as: uBlock Origin.