Compare commits

...

3 commits
v1.2.2 ... main

Author SHA1 Message Date
dd54e8cc49
add warnings for exceeding metadata character length
All checks were successful
/ build-linux-amd64 (push) Successful in 2m47s
2026-02-01 17:08:16 +00:00
9f32aedc3b
exclude dot-prefixed files from footage scan
All checks were successful
/ build-linux-amd64 (push) Successful in 3m18s
2026-01-31 18:10:39 +00:00
c52290392d
update README 2026-01-31 04:19:20 +00:00
3 changed files with 42 additions and 18 deletions

View file

@ -14,8 +14,13 @@ I built this to greatly simplify the process of getting my full-quality livestre
$ vodular
New config file created (config.toml). Please edit this file before running again!
```
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 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).
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:
@ -63,10 +68,11 @@ url = 'https://example.org'
```
## Templates
Template files can be created at `templates/title.txt`,
`template/description.txt`, and `templates/tags.txt` respectively. These
files can use Go's [text template format](https://pkg.go.dev/text/template) to
customise VOD metadata on upload.
There are three template files, `title.txt`, `description.txt`, and `tags.txt`,
which can be created in `/path/to/vodular/templates`. These templates can be
created and tweaked to customise your VOD metadata on upload. They are enhanced
with Go's [template format](https://pkg.go.dev/text/template) to inject
information provided in `metadata.toml`, and other neat functionality!
You can use the following data in templates:
- **`.Title`:** The title of the stream.

43
main.go
View file

@ -26,7 +26,9 @@ import (
//go:embed res/help.txt
var helpText string
const segmentExtension = "mkv"
const SEGMENT_EXTENSION = "mkv"
const MAX_TITLE_LEN = 100
const MAX_DESCRIPTION_LEN = 5000
func showHelp() {
fmt.Println(helpText)
@ -194,7 +196,7 @@ func main() {
}
// scan for VOD segments
vodFiles, err := scanner.ScanSegments(metadata.FootageDir, segmentExtension)
vodFiles, err := scanner.ScanSegments(metadata.FootageDir, SEGMENT_EXTENSION)
if err != nil {
log.Fatalf("Failed to fetch VOD filenames: %v", err)
os.Exit(1)
@ -202,7 +204,7 @@ func main() {
if len(vodFiles) == 0 {
log.Fatalf(
"Directory contained no VOD files (expecting .%s)",
segmentExtension,
SEGMENT_EXTENSION,
)
os.Exit(1)
}
@ -221,21 +223,35 @@ func main() {
log.Fatalf("Failed to build video template: %v", err)
os.Exit(1)
}
title, err := yt.BuildTemplate(video, templates.Title)
if err != nil {
log.Fatalf("Failed to build video title: %v", err)
os.Exit(1)
}
description, err := yt.BuildTemplate(video, templates.Description)
if err != nil {
log.Fatalf("Failed to build video description: %v", err)
os.Exit(1)
}
if len(title) > 100 {
log.Fatalf(
"Video title length exceeds %d characters (%d). YouTube may reject this!",
MAX_TITLE_LEN,
len(video.Title),
)
}
if len(description) > 5000 {
log.Fatalf(
"Video description length exceeds %d characters (%d). YouTube may reject this!",
MAX_DESCRIPTION_LEN,
len(description),
)
}
if verbose {
enc := json.NewEncoder(os.Stdout)
fmt.Printf("\nVideo template: ")
enc.Encode(video)
title, err := yt.BuildTemplate(video, templates.Title)
if err != nil {
log.Fatalf("Failed to build video title: %v", err)
os.Exit(1)
}
description, err := yt.BuildTemplate(video, templates.Description)
if err != nil {
log.Fatalf("Failed to build video description: %v", err)
os.Exit(1)
}
fmt.Printf(
"\n================================\n\n" +
"< TITLE >\n%s\n\n" +
@ -317,6 +333,7 @@ func main() {
log.Print("Video uploaded successfully!")
// update metadata to reflect VOD is uploaded
// TODO: rather than a boolean flag, link to actual video
metadata.Uploaded = true
err = scanner.WriteMetadata(directory, metadata)
if err != nil {

View file

@ -51,6 +51,7 @@ func ScanSegments(directory string, extension string) ([]string, error) {
for _, item := range entries {
if item.IsDir() { continue }
if strings.HasPrefix(item.Name(), ".") { continue }
if !strings.HasSuffix(item.Name(), "." + extension) { continue }
if strings.HasSuffix(item.Name(), "-fullvod." + extension) { continue }
files = append(files, item.Name())