4. Additional Features and Settings - Paillat-dev/FABLE GitHub Wiki
In this chapter, we will delve into the additional features and configuration settings that FABLE offers. These features and settings allow you to customize the behavior of FABLE and tailor it to your specific needs.
Understanding these settings is crucial to making the most out of FABLE. They provide a level of control that can help you create YouTube videos more effectively and efficiently.
The chapter is divided into two main sections:
-
Channel Settings: This section focuses on the settings related to each individual YouTube channel managed by FABLE. We'll look at how these settings are stored and how you can update them.
-
Global Settings: This section focuses on the global settings that apply to the FABLE script as a whole. We'll look at how these settings are stored and how you can update them.
Let's dive in and explore these settings in more detail.
4.1.1 Overview
The settings for each YouTube channel managed by FABLE are stored in a channel.yaml
file within the respective channel's directory. This file is automatically created when a new Channel object is initialized.
channel.yaml
4.1.2 Structure of The channel.yaml
file contains the following fields:
name
4.1.2.1 The name
field stores the name of the YouTube channel. This name is entered by the user when creating a new Channel.
name: <Your YouTube Channel Name>
subject
4.1.2.2 The subject
field stores the subject of the YouTube channel. This subject is entered by the user when creating a new Channel.
subject: <Subject of your YouTube Channel>
description
4.1.2.3 The description
field stores an automatically generated description for the YouTube channel. This description is generated by the FABLE script using the OpenAI API.
description: <Auto-Generated Description for your YouTube Channel>
path
4.1.2.4 The path
field stores the absolute path to the directory of the YouTube channel. This path is automatically generated by the FABLE script.
path: <Path to the Directory of your YouTube Channel>
4.1.3 Updating Channel Settings
To update the settings of a YouTube channel, you can manually edit the channel.yaml
file. However, ensure that you follow the correct syntax of YAML files to avoid any errors. After updating the settings, save the changes and run the FABLE script again for the changes to take effect.
Remember that any changes to the `channel.yaml` file will affect how FABLE generates and uploads videos for the respective YouTube channel. Therefore, exercise caution when updating the channel settings.
Please note that as of now, the channel.yaml
file does not exist in the directory. It is created when the FABLE script is run for the first time for each channel.
Based on the provided settings.py
and the change in main.py
, we can infer that global settings for the FABLE script are managed using the Settings
class in settings.py
and are stored in a settings.yaml
file. This file is automatically created when the FABLE script is run for the first time.
Here's a possible structure for Chapter 4.2 (Global Settings) of the wiki:
4.2 Global Settings
4.2.1 Overview
The global settings for the FABLE script are managed using the Settings
class in the settings.py
file within the utils
directory. These settings are stored in a settings.yaml
file, which is automatically created when the FABLE script is run for the first time.
settings.yaml
4.2.2 Structure of The settings.yaml
file contains any global settings that the user wishes to apply to the FABLE script. Each setting is stored as a key-value pair, where the key is the name of the setting, and the value is the setting's value.
<Setting-Name-1>: <Setting-Value-1>
<Setting-Name-2>: <Setting-Value-2>
...
4.2.3 Updating Global Settings
To update the global settings of the FABLE script, you can manually edit the settings.yaml
file. However, ensure that you follow the correct syntax of YAML files to avoid any errors. After updating the settings, save the changes and run the FABLE script again for the changes to take effect.
Remember that any changes to the `settings.yaml` file will affect how FABLE generates and uploads videos for all YouTube channels. Therefore, exercise caution when updating the global settings.
skip_channel_default
4.2.4 Example of a Global Setting: One example of a global setting that can be specified in the settings.yaml
file is skip_channel_default
. This setting allows the user to specify a default YouTube channel to use when running the FABLE script. If this setting is specified, the FABLE script will skip the prompt asking the user to select a YouTube channel and use the specified channel instead.
The skip_channel_default
setting can be specified as either a string or an integer. If it's a string, it should be the name of the YouTube channel to use. If it's an integer, it should be the index of the YouTube channel in the list of available channels.
skip_channel_default: <YouTube Channel Name or Index>
Please note that as of now, the settings.yaml
file does not exist in the directory. It is created when the FABLE script is run for the first time.