Configuration Documentation - kubinka0505/iFunny-Captions GitHub Wiki
This page displays the documentation of the Config.json's parameters for the latest version of the program.
ℹ️ - Additional tips about program usage.
Content | -t
User's caption text. Supports emojis in English language that have to be in the Unicode format (🐍) or between colons. (:snake:)
-
ℹ️ If empty, user will have to enter text manually through the command line window.
-
If the user's text will contain a quotation mark (
") or escape character (\) the text have to be configured as in the following examples:Base Result Yea, I've played \"Helltaker\"Yea, I've played "Helltaker"This is ''Example Text''This is "Example Text"`_{bs} VIP
Additional_Wrap | -w
Decreases text wrap width value. Default is -8.
Kerning | -k
Pixels space between all characters, including emojis. Default is -1.
Replacements
Dictionary containing manual string replacements.
API_Type
Used to create emoji images used in Content. Default is 1.
- ℹ️ If
1selectsEmojiCDN.- ℹ️ Roughly supported emoji input list
- ℹ️ Supported styles list
⚠️ PIL.UnidentifiedImageErrorexception will be thrown in the case of unsupported emoji on the current style.
- ℹ️ If
2selectsauepa.-
auepaimage styles documentation ⚠️ The more emojis a certain style has, the slower web scraping for them will be.
-
Style_if_1
Selects emoji style.
-API Type is 1!
-
Vendor_if_2
Selects emojis vendor.
- API Type is 2!
Version_if_2 - Selects emojis version.
- API Type is 2!
URL_or_Path | -i
Direct media URL / Path. It can be any Image/Video format that FFmpeg supports.
- If
clipboard, fetches the clipboard of the user. - If empty, asks user for the file selection.
- In case of abortion, the user will be asked to enter the URL or absolute path to the image manually through the command line window.
⚠️ If the user's operating system is Windows, backslashes have to be replaced with slashes!
Scale_Back | -sb
Scales image to its original first frame width and height after processing. Default is true.
-
Watermark | -w
Adds an old iFunny watermark in the bottom right corner of the caption field. Default is false.
Start | -ss, -ls
Video start value in suitable FFmpeg format.
End | -to, -le
Encodes video for given amount of seconds.
URL_or_Path | -a
Direct audio URL / Path. It can be any audio format that FFmpeg supports
- MP4 video!
Channels | -ac
Amount of channels in audio file. Default is 2.
| Value | Output |
|---|---|
1 |
Mono |
2 |
Stereo |
3 |
Left → Mono |
4 |
Right → Mono |
5 |
Side → Mono |
Bitrate | -ab
Bitrate of the video's audio. (kb/s)
- ℹ️ Ignored when higher than original input.
Keep_Image | -ki
Default is false.
Type | -f
Defines font style used as a caption text. Default is 2.
- ℹ️ Custom Fonts Instruction
| Value | Output |
|---|---|
0 |
Random |
1 |
Roboto Condensed BlackAndroid font. (used in the app to 2021) |
2 |
Futura Condensed Extra BoldiOS font |
Delay | -d
Single frame display time. () Default is
5.
- If
1- Delay (in code) is2, but removes every 2nd frame, so it tries to appear as the Delay was smaller.⚠️ InputtedDelayis increased by1in code sometimes.
Loop_Count -l
Dynamic image loop count. Default is 0.
- ℹ️ Numbers below 1 means infinite.
Percentage_Elements_Size | -pes
Fully configurable caption design, maintaining elements size manipulation.
Colors
Caption elements colors.
Enabled | -no
Default is true.
-
Colors
Target amount of colors in the final image. Default is256.
-⚠️ Number has to be to the power of2and cannot exceed256!
-
Speed- Default is1.
-⚠️ The smaller the number, the smaller file size! (extends the processing time)
-
Colors
As above.
-
Lossy
Lossy compression value. Default is200.
-⚠️ In some cases, GIFs can result in larger file size.
Changes the colors of the Font to #A0A0A0 and Caption Field to #141414. (default)
Enabled | -dm
Default is false.
After_Hour
Activates after set hour in 24-hour time format. Default is 22.
Logs | -v 1
Default is false.
- ℹ️ Enabling this option will turn ALL the packages to verbose mode!
Enabled
Default is false.
Colors
HEX representation of outputted colors in prints.
Add_Metadata | -m
Self-explanatory. Every file path is censored from user profile name. Default is true.
Consists of:
TextImage-
Audio- added if possible
Open_Folder | -p
Displays a messagebox with information about made file. Default is false.
Time_Logs
Displays information about image creation time. Default is true.
Sound
Prints a ring character - BEL (CTRL + G) on exceptions and other important messages. Default is true.