Configuration - TheNamesArthur/rulescrape GitHub Wiki

User Configuration File (user_settings.config)

Rulescrape uses a simple INI-style configuration file named user_settings.config to store user preferences and application state. This file is automatically created and updated as you use the GUI or CLI.

Location

  • The file is located in the root of your Rulescrape directory.

Structure

The config file is divided into sections, typically [Settings] and [UI].

Example

[Settings]
# Which booru site to use (e.g. rule34, safebooru, danbooru)
booru_type = rule34
# Tag to search for
tag = 1boy
# Number of images to download
limit = 20
# Exclude AI-generated content (True/False)
anti_ai = True
# Enable multithreaded downloads (True/False)
multithread = True
# Organization method for images
org_method = By extension only
# Number of threads for multithreaded downloads
max_workers = 8

[UI]
# Skin/theme file for GUI
skin = modern_blue.json
# GUI window width
window_width = 400
# GUI window height
window_height = 320

Option Reference

  • booru_type: Selects the booru API (rule34, safebooru, danbooru).
  • tag: The search tag or query string for images.
  • limit: Maximum number of images to download per session.
  • anti_ai: If True, excludes AI-generated images using known tags.
  • multithread: If True, enables parallel downloads (faster, but progress bar may be less accurate).
  • org_method: Controls how images are organized in folders. Options:
    • By extension and first tag
    • By extension only
    • Flat (no folders)
    • By tag only
  • max_workers: Number of threads for multithreaded downloads (default is half your CPU cores).
  • skin: Name of the skin JSON file in the skins/ directory.
  • window_width/window_height: GUI window size in pixels.

Editing

  • You can edit user_settings.config manually with any text editor.
  • Changes will be picked up the next time you launch Rulescrape.
  • The GUI will overwrite settings as you interact with it.

Tips

  • If you encounter issues, try deleting or resetting the config file; it will be recreated with defaults.
  • For custom skins, set skin to the filename of your skin JSON in the skins/ folder.
  • The config file is not portable between major versions; check for new options after upgrading.