first commit

2026-04-18 07:03:37 +00:00 · 2025-04-24 11:54:51 +01:00
commit 2037a64e98
23 changed files with 2011 additions and 0 deletions
--- a/main.go
+++ b/main.go
@@ -0,0 +1,94 @@
+// Package main provides a command-line interface (CLI) tool for interacting with OBS WebSocket.
+// It allows users to manage various aspects of OBS, such as scenes, inputs, recording, streaming,
+// and more, by leveraging the goobs library for communication with the OBS WebSocket server.
+package main
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"time"
+
+	"github.com/alecthomas/kong"
+	"github.com/andreykaipov/goobs"
+)
+
+// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
+type ObsConfig struct {
+	Host     string `flag:"host"     help:"Host to connect to."          default:"localhost" env:"OBS_HOST"`
+	Port     int    `flag:"port"     help:"Port to connect to."          default:"4455"      env:"OBS_PORT"`
+	Password string `flag:"password" help:"Password for authentication." default:""          env:"OBS_PASSWORD"`
+	Timeout  int    `flag:"timeout"  help:"Timeout in seconds."          default:"5"         env:"OBS_TIMEOUT"`
+}
+
+// cli is the main command line interface structure.
+// It embeds the ObsConfig struct to inherit its fields and flags.
+type cli struct {
+	ObsConfig `embed:"" help:"OBS WebSocket configuration."`
+
+	Version         VersionCmd         `help:"Show version."             cmd:"" aliases:"v"`
+	Scene           SceneCmd           `help:"Manage scenes."            cmd:"" aliases:"sc"`
+	Sceneitem       SceneItemCmd       `help:"Manage scene items."       cmd:"" aliases:"si"`
+	Group           GroupCmd           `help:"Manage groups."            cmd:"" aliases:"g"`
+	Input           InputCmd           `help:"Manage inputs."            cmd:"" aliases:"i"`
+	Record          RecordCmd          `help:"Manage recording."         cmd:"" aliases:"rec"`
+	Stream          StreamCmd          `help:"Manage streaming."         cmd:"" aliases:"st"`
+	Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn"`
+	Profile         ProfileCmd         `help:"Manage profiles."          cmd:"" aliases:"p"`
+	Replaybuffer    ReplayBufferCmd    `help:"Manage replay buffer."     cmd:"" aliases:"rb"`
+	Studiomode      StudioModeCmd      `help:"Manage studio mode."       cmd:"" aliases:"sm"`
+	Virtualcam      VirtualCamCmd      `help:"Manage virtual camera."    cmd:"" aliases:"vc"`
+}
+
+type context struct {
+	Client *goobs.Client
+	Out    io.Writer
+}
+
+func main() {
+	var client *goobs.Client
+	cli := cli{}
+	ctx := kong.Parse(
+		&cli,
+		kong.Name("GOBS-CLI"),
+		kong.Description("A command line tool to interact with OBS Websocket."),
+	)
+
+	client, err := connectObs(cli.ObsConfig)
+	if err != nil {
+		ctx.FatalIfErrorf(err)
+	}
+
+	ctx.Bind(&context{
+		Client: client,
+		Out:    os.Stdout,
+	})
+
+	ctx.FatalIfErrorf(run(ctx, client))
+}
+
+// connectObs creates a new OBS client and connects to the OBS WebSocket server.
+func connectObs(cfg ObsConfig) (*goobs.Client, error) {
+	client, err := goobs.New(
+		fmt.Sprintf("%s:%d", cfg.Host, cfg.Port),
+		goobs.WithPassword(cfg.Password),
+		goobs.WithResponseTimeout(time.Duration(cfg.Timeout)*time.Second),
+	)
+	if err != nil {
+		return nil, err
+	}
+	return client, nil
+}
+
+// run executes the command line interface.
+// It disconnects the OBS client after the command is executed.
+func run(ctx *kong.Context, client *goobs.Client) error {
+	defer func() error {
+		if err := client.Disconnect(); err != nil {
+			return fmt.Errorf("failed to disconnect from OBS: %w", err)
+		}
+		return nil
+	}()
+
+	return ctx.Run()
+}