output folder settings - panuozzo77/StreamingCommunity GitHub Wiki

Output Folder Settings

This section documents the settings that control where and how StreamingCommunity organizes downloaded content. These settings determine the directory structure and file naming conventions for your media library.

Configuration Location

These settings are found in the OUT_FOLDER section of the config.json file:

{
    "OUT_FOLDER": {
        "root_path": "Video",
        "movie_folder_name": "Movie",
        "serie_folder_name": "Serie",
        "anime_folder_name": "Anime",
        "map_episode_name": "E%(episode)_%(episode_name)",
        "add_siteName": false
    }
}

Available Settings

root_path

  • Type: String
  • Default: "Video"
  • Description: The base directory where all downloaded content will be saved. This can be a relative or absolute path.
  • Examples:
    • Windows: "C:\\MyLibrary\\Folder" or "\\\\MyServer\\MyLibrary" (for network folders)
    • Linux/macOS: "Desktop/MyLibrary/Folder" or "/home/user/Videos"
  • Usage: Set this to your preferred location for storing downloaded media.

movie_folder_name

  • Type: String
  • Default: "Movie"
  • Description: The name of the subdirectory within the root path where movies will be stored.
  • Command Line Override: --movie_folder_name "Movies"
  • Usage: Customize this if you prefer a different folder name for your movie collection.

serie_folder_name

  • Type: String
  • Default: "Serie"
  • Description: The name of the subdirectory within the root path where TV series will be stored.
  • Command Line Override: --serie_folder_name "TV Shows"
  • Usage: Customize this if you prefer a different folder name for your TV series collection.

anime_folder_name

  • Type: String
  • Default: "Anime"
  • Description: The name of the subdirectory within the root path where anime will be stored.
  • Command Line Override: --anime_folder_name "Anime Series"
  • Usage: Customize this if you prefer a different folder name for your anime collection.

map_episode_name

  • Type: String
  • Default: "E%(episode)_%(episode_name)"
  • Description: Template for episode filenames. This determines how episode files are named.
  • Command Line Override: --map_episode_name "S%(season)E%(episode)_%(episode_name)"
  • Variables:
    • %(tv_name): The name of the TV show
    • %(season): The season number
    • %(episode): The episode number
    • %(episode_name): The name of the episode
  • Usage: Customize this to match your preferred naming convention for TV episodes.

add_siteName

  • Type: Boolean
  • Default: false
  • Description: When enabled, the site name is appended to the root path before the movie and series folders. This helps organize content by source.
  • Command Line Override: --add_siteName true/false
  • Usage: Set to true if you want to organize your media by the site it was downloaded from.

Directory Structure Examples

Basic Structure (Default Settings)

Video/
├── Movie/
│   ├── Movie Title 1.mp4
│   └── Movie Title 2.mp4
├── Serie/
│   ├── Show Name 1/
│   │   ├── Season 1/
│   │   │   ├── E1_Episode Name.mp4
│   │   │   └── E2_Episode Name.mp4
│   │   └── Season 2/
│   └── Show Name 2/
└── Anime/
    └── Anime Title/
        └── Season 1/
            ├── E1_Episode Name.mp4
            └── E2_Episode Name.mp4

With add_siteName Enabled

Video/
├── streamingcommunity/
│   ├── Movie/
│   │   └── Movie Title 1.mp4
│   └── Serie/
│       └── Show Name 1/
├── animeworld/
│   └── Anime/
│       └── Anime Title/
└── altadefinizione/
    └── Movie/
        └── Movie Title 2.mp4

Custom Episode Naming

With map_episode_name set to "S%(season)E%(episode) - %(episode_name)":

Video/
└── Serie/
    └── Show Name/
        └── Season 1/
            ├── S1E1 - Pilot.mp4
            └── S1E2 - The Beginning.mp4

Command Line Overrides

These settings can be overridden via command line arguments when running the application:

python test_run.py --movie_folder_name "Films" --serie_folder_name "TV Shows" --add_siteName true

Programmatic Access

You can access and modify these settings programmatically:

from StreamingCommunity.Util.config_json import config_manager

# Get a configuration value
root_path = config_manager.get('OUT_FOLDER', 'root_path')

# Set a configuration value
config_manager.set_key('OUT_FOLDER', 'root_path', '/media/external/downloads')
config_manager.save_config()

Related Settings

⚠️ **GitHub.com Fallback** ⚠️