ari/vodular
1
0
Fork 0
Code Issues Releases 6 Activity Actions

update documentation

Browse source
This commit is contained in:
ari melody 2026-06-28 16:37:42 +01:00
parent 0abafd26c5
commit 75534da702
Signed by: ari
GPG key ID: 60B5F0386E3DDB7E
3 changed files with 43 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,7 +1,12 @@
# Vodular
This tool stitches together livestream VOD segments (in `.mkv`format) and automatically uploads them to YouTube, complete with customisable metadata such as titles, descriptions, tags, and a thumbnail!
This tool stitches together livestream VOD segments (in `.mkv` format) and
automatically uploads them to YouTube, complete with customisable metadata such
as titles, descriptions, tags, and a thumbnail!
I built this to greatly simplify the process of getting my full-quality livestream VODs onto YouTube, and I'm open-sourcing it in the hopes that it helps someone else with their workflow. As such, personal forks are welcome and encouraged!
I built this to greatly simplify the process of getting my full-quality
livestream VODs onto YouTube, and I'm open-sourcing it in the hopes that it
helps someone else with their workflow. As such, personal forks are welcome and
encouraged!
## Quick Jump
- [Basic Usage](#basic-usage)
@ -9,40 +14,40 @@ I built this to greatly simplify the process of getting my full-quality livestre
- [Templates](#templates)
## Basic usage
1. Run the tool for the first time to generate a starter configuration file:
```sh
$ vodular
New config file created (config.toml). Please edit this file before running again!
```
1. Run `vodular` for the first time to generate a starter configuration file:
The directory which holds your configuration file and templates varies,
depending on platform:
- **Linux:** `~/.config/vodular/templates`
- **macOS:** `~/Library/Application Support/vodular/templates`
- **Windows:** `%AppData%/vodular/templates`
2. Edit your configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here).
**IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone.
2. Edit your configuration file as necessary (You will need to create a
[YouTube Data API v3](https://developers.google.com/youtube/v3) service and
provide its credentials here).
**IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share
this file with anyone.
3. Initialise a VOD directory:
```sh
$ vodular --init /path/to/vod
Directory successfully initialised. Be sure to update metadata.toml before uploading!
vodular --init /path/to/vod
```
This directory should contain:
- A `metadata.toml` file
- Your footage files, either at the root of the directory or in a specified subdirectory
- Your footage files, either at the root of the directory or in a specified
subdirectory
- Your thumbnail, specifically named `thumbnail.png`
4. Modify your newly-created `metadata.toml` to your liking.
5. Upload a VOD!
```sh
# `--deleteAfter` deletes the redundant full VOD export afterwards
vodular --deleteAfter /path/to/vod
vodular /path/to/vod
```
**NOTE:** On first run, you will be prompted to sign in to YouTube with the channel you wish to upload to. To sign out, simply run `vodular --logout`.
**NOTE:** On first run, you will be prompted to log into YouTube with the
channel you wish to upload to. To log out, simply run `vodular --logout`.
## VOD Metadata
When `--init`ialising a directory, a `metadata.toml` file is created. This is a
@ -56,13 +61,12 @@ title = 'Untitled Stream'
part = 0
# The date of the stream
date = '2026-01-28'
# (Optional) Additional tags to add to this VOD's metadata.
# (Optional) VOD-specific tags. Added to global tags template.
tags = ['livestream', 'VOD']
# (Optional) Footage directory override, for more complex directory structures.
footage_dir = 'footage'
# Set to `true` by the tool when the VOD has been uploaded successfully.
# Prevents future uploads unless `--force` is used.
uploaded = false
# On successful upload, updated to a URL to the video.
upload_url = false
# (Optional) Category details, for additional credits.
[category]