├── .gitignore ├── .github └── logo.png ├── .env.example ├── internal ├── youtube │ └── client.go ├── common │ └── common.go ├── discord │ ├── session.go │ └── discord.go ├── command │ ├── commands │ │ ├── ping.go │ │ ├── help.go │ │ ├── health.go │ │ ├── skip.go │ │ ├── stop.go │ │ ├── pause.go │ │ ├── unpause.go │ │ └── play.go │ └── command.go ├── config │ └── config.go ├── util │ ├── logger.go │ └── io.go ├── player │ ├── song.go │ ├── stream.go │ └── queue.go └── bot │ └── bot.go ├── .editorconfig ├── Dockerfile ├── go.mod ├── cmd └── main.go ├── README.md ├── go.sum └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .env 3 | .env.local 4 | temp/ 5 | -------------------------------------------------------------------------------- /.github/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/larahfelipe/saturn/HEAD/.github/logo.png -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | BOT_TOKEN= 2 | BOT_COMMAND_PREFIX= 3 | BOT_ACTIVITY_STATUS="Hello world!" 4 | APP_ENVIRONMENT=development # development/production 5 | -------------------------------------------------------------------------------- /internal/youtube/client.go: -------------------------------------------------------------------------------- 1 | package youtube 2 | 3 | import ( 4 | yt "github.com/kkdai/youtube/v2" 5 | ) 6 | 7 | // New creates a new `yt.Client` record. 8 | func New() *yt.Client { 9 | return &yt.Client{} 10 | } 11 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_style = space 6 | indent_size = 2 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1.24.9 AS builder 2 | 3 | WORKDIR /usr/src/app 4 | 5 | COPY go.mod go.sum ./ 6 | 7 | RUN go mod download 8 | 9 | COPY . . 10 | 11 | RUN go build -o /go/bin/app ./cmd 12 | 13 | FROM golang:1.24.9 14 | 15 | WORKDIR /usr/src/app 16 | 17 | RUN apt-get update && \ 18 | apt-get install -y --no-install-recommends ca-certificates ffmpeg && \ 19 | apt-get clean autoclean && \ 20 | rm -rf /var/lib/apt/lists/* 21 | 22 | COPY --from=builder /go/bin/app /go/bin/app 23 | 24 | COPY .env . 25 | 26 | EXPOSE 8080 27 | 28 | CMD ["/go/bin/app"] 29 | -------------------------------------------------------------------------------- /internal/common/common.go: -------------------------------------------------------------------------------- 1 | package common 2 | 3 | import "fmt" 4 | 5 | var ( 6 | ErrMissingDiscordBotToken = fmt.Errorf("missing bot token") 7 | ErrMissingDiscordBotPrefix = fmt.Errorf("missing bot command prefix") 8 | ErrMissingYoutubeVideoUrl = fmt.Errorf("missing youtube video url") 9 | ErrUnknownOrUnavailableCommand = fmt.Errorf("triggered an unknown or unavailable command") 10 | ErrUnknownVoiceChannel = fmt.Errorf("could not find the message's author voice channel") 11 | ErrUnknownFileExtFromMimeType = fmt.Errorf("could not determine file extension from mime type") 12 | ErrInvalidPrintDataType = fmt.Errorf("input object is not a struct") 13 | ) 14 | -------------------------------------------------------------------------------- /internal/discord/session.go: -------------------------------------------------------------------------------- 1 | package discord 2 | 3 | import dg "github.com/bwmarrin/discordgo" 4 | 5 | type Discord struct { 6 | Session *dg.Session 7 | } 8 | 9 | // New creates a new discord service. 10 | func New(token string) (*Discord, error) { 11 | s, err := dg.New("Bot " + token) 12 | if err != nil { 13 | return nil, err 14 | } 15 | 16 | return &Discord{Session: s}, nil 17 | } 18 | 19 | // Connect creates a websocket connection to Discord. 20 | func (d *Discord) Connect() error { 21 | if err := d.Session.Open(); err != nil { 22 | return err 23 | } 24 | 25 | return nil 26 | } 27 | 28 | // Disconnect closes a websocket connection to Discord. 29 | func (d *Discord) Disconnect() error { 30 | if err := d.Session.Close(); err != nil { 31 | return err 32 | } 33 | 34 | return nil 35 | } 36 | -------------------------------------------------------------------------------- /internal/command/commands/ping.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "github.com/larahfelipe/saturn/internal/bot" 5 | "github.com/larahfelipe/saturn/internal/command" 6 | ) 7 | 8 | type PingCommand struct { 9 | *command.BaseCommand 10 | Bot *bot.Bot 11 | } 12 | 13 | func NewPingCommand(bot *bot.Bot) *PingCommand { 14 | return &PingCommand{ 15 | BaseCommand: command.NewBaseCommand("ping", "Ping the bot", true), 16 | Bot: bot, 17 | } 18 | } 19 | 20 | func (pc *PingCommand) Active() bool { 21 | return pc.BaseCommand.Active 22 | } 23 | 24 | func (pc *PingCommand) Name() string { 25 | return pc.BaseCommand.Name 26 | } 27 | 28 | func (pc *PingCommand) Help() string { 29 | return pc.BaseCommand.Help 30 | } 31 | 32 | func (pc *PingCommand) Execute(m *command.Message) error { 33 | pc.Bot.DS.SendReplyMessage(m.Message, "Pong!") 34 | return nil 35 | } 36 | -------------------------------------------------------------------------------- /internal/config/config.go: -------------------------------------------------------------------------------- 1 | package config 2 | 3 | import ( 4 | "fmt" 5 | "log" 6 | "os" 7 | 8 | env "github.com/joho/godotenv" 9 | ) 10 | 11 | type Config struct { 12 | BotToken string 13 | BotPrefix string 14 | BotStatus string 15 | AppEnvironment string 16 | AppLogsDirName string 17 | } 18 | 19 | func New() (*Config, error) { 20 | if err := env.Load(); err != nil { 21 | log.Printf("environment variables load warning: %s", err) 22 | } 23 | 24 | cfg := &Config{ 25 | BotToken: os.Getenv("BOT_TOKEN"), 26 | BotPrefix: os.Getenv("BOT_COMMAND_PREFIX"), 27 | BotStatus: os.Getenv("BOT_ACTIVITY_STATUS"), 28 | AppEnvironment: os.Getenv("APP_ENVIRONMENT"), 29 | AppLogsDirName: ".logs", 30 | } 31 | 32 | if cfg.BotToken == "" { 33 | return nil, fmt.Errorf("BOT_TOKEN is required") 34 | } 35 | 36 | return cfg, nil 37 | } 38 | -------------------------------------------------------------------------------- /internal/command/commands/help.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "github.com/larahfelipe/saturn/internal/bot" 5 | "github.com/larahfelipe/saturn/internal/command" 6 | ) 7 | 8 | type HelpCommand struct { 9 | *command.BaseCommand 10 | Bot *bot.Bot 11 | } 12 | 13 | func NewHelpCommand(bot *bot.Bot) *HelpCommand { 14 | return &HelpCommand{ 15 | BaseCommand: command.NewBaseCommand("help", "Show available commands", false), 16 | Bot: bot, 17 | } 18 | } 19 | 20 | func (hc *HelpCommand) Active() bool { 21 | return hc.BaseCommand.Active 22 | } 23 | 24 | func (hc *HelpCommand) Name() string { 25 | return hc.BaseCommand.Name 26 | } 27 | 28 | func (hc *HelpCommand) Help() string { 29 | return hc.BaseCommand.Help 30 | } 31 | 32 | func (hc *HelpCommand) Execute(m *command.Message) error { 33 | hc.Bot.DS.SendMessageEmbed(m.Message, hc.Bot.DS.BuildMessageEmbed("Help command")) 34 | return nil 35 | } 36 | -------------------------------------------------------------------------------- /internal/util/logger.go: -------------------------------------------------------------------------------- 1 | package util 2 | 3 | import ( 4 | "fmt" 5 | 6 | "github.com/larahfelipe/saturn/internal/config" 7 | "go.uber.org/zap" 8 | ) 9 | 10 | // NewLogger creates a new logger instance. 11 | func NewLogger(cfg *config.Config) (*zap.Logger, error) { 12 | var logger *zap.Logger 13 | var err error 14 | 15 | if cfg.AppEnvironment == "development" { 16 | logger, err = zap.NewDevelopment() 17 | } else { 18 | if err := MkDir(cfg.AppLogsDirName); err != nil { 19 | return nil, fmt.Errorf("logs directory creation error: %w", err) 20 | } 21 | 22 | zapProdCfg := zap.NewProductionConfig() 23 | zapProdCfg.Level = zap.NewAtomicLevel() 24 | zapProdCfg.OutputPaths = []string{"stdout", fmt.Sprintf("%s/app.log", cfg.AppLogsDirName)} 25 | 26 | logger, err = zapProdCfg.Build() 27 | } 28 | 29 | if err != nil { 30 | return nil, err 31 | } 32 | 33 | zap.ReplaceGlobals(logger) 34 | 35 | return logger, nil 36 | } 37 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/larahfelipe/saturn 2 | 3 | go 1.24.9 4 | 5 | require ( 6 | github.com/bwmarrin/discordgo v0.29.0 7 | github.com/joho/godotenv v1.5.1 8 | github.com/jonas747/dca v0.0.0-20210930103944-155f5e5f0cc7 9 | github.com/kkdai/youtube/v2 v2.10.5 10 | go.uber.org/zap v1.27.1 11 | ) 12 | 13 | require ( 14 | github.com/bitly/go-simplejson v0.5.1 // indirect 15 | github.com/dlclark/regexp2 v1.11.5 // indirect 16 | github.com/dop251/goja v0.0.0-20251201205617-2bb4c724c0f9 // indirect 17 | github.com/go-sourcemap/sourcemap v2.1.4+incompatible // indirect 18 | github.com/google/pprof v0.0.0-20251208000136-3d256cb9ff16 // indirect 19 | github.com/gorilla/websocket v1.5.3 // indirect 20 | github.com/jonas747/ogg v0.0.0-20161220051205-b4f6f4cf3757 // indirect 21 | go.uber.org/multierr v1.11.0 // indirect 22 | golang.org/x/crypto v0.46.0 // indirect 23 | golang.org/x/sys v0.39.0 // indirect 24 | golang.org/x/text v0.32.0 // indirect 25 | ) 26 | -------------------------------------------------------------------------------- /internal/command/commands/health.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "fmt" 5 | 6 | "github.com/larahfelipe/saturn/internal/bot" 7 | "github.com/larahfelipe/saturn/internal/command" 8 | ) 9 | 10 | type HealthCommand struct { 11 | *command.BaseCommand 12 | Bot *bot.Bot 13 | } 14 | 15 | func NewHealthCommand(bot *bot.Bot) *HealthCommand { 16 | return &HealthCommand{ 17 | BaseCommand: command.NewBaseCommand("health", "Check bot's health", true), 18 | Bot: bot, 19 | } 20 | } 21 | 22 | func (hc *HealthCommand) Active() bool { 23 | return hc.BaseCommand.Active 24 | } 25 | 26 | func (hc *HealthCommand) Name() string { 27 | return hc.BaseCommand.Name 28 | } 29 | 30 | func (hc *HealthCommand) Help() string { 31 | return hc.BaseCommand.Help 32 | } 33 | 34 | func (hc *HealthCommand) Execute(m *command.Message) error { 35 | latencyMs := hc.Bot.DS.Session.HeartbeatLatency().Milliseconds() 36 | hc.Bot.DS.SendMessageEmbed(m.Message, hc.Bot.DS.BuildMessageEmbed(fmt.Sprintf("Heartbeat latency: %dms", latencyMs))) 37 | 38 | return nil 39 | } 40 | -------------------------------------------------------------------------------- /internal/command/commands/skip.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "github.com/larahfelipe/saturn/internal/bot" 5 | "github.com/larahfelipe/saturn/internal/command" 6 | "github.com/larahfelipe/saturn/internal/player" 7 | ) 8 | 9 | type SkipSongCommand struct { 10 | *command.BaseCommand 11 | Bot *bot.Bot 12 | Queue *player.Queue 13 | } 14 | 15 | func NewSkipSongCommand(bot *bot.Bot, queue *player.Queue) *SkipSongCommand { 16 | return &SkipSongCommand{ 17 | BaseCommand: command.NewBaseCommand("skip", "Skip the current song", true), 18 | Bot: bot, 19 | Queue: queue, 20 | } 21 | } 22 | 23 | func (ssc *SkipSongCommand) Active() bool { 24 | return ssc.BaseCommand.Active 25 | } 26 | 27 | func (ssc *SkipSongCommand) Name() string { 28 | return ssc.BaseCommand.Name 29 | } 30 | 31 | func (ssc *SkipSongCommand) Help() string { 32 | return ssc.BaseCommand.Help 33 | } 34 | 35 | func (ssc *SkipSongCommand) Execute(m *command.Message) error { 36 | if ssc.Queue.Idle { 37 | ssc.Bot.DS.SendReplyMessage(m.Message, "There is no song playing right now") 38 | return nil 39 | } 40 | 41 | ssc.Queue.PlaybackState <- player.SKIP 42 | ssc.Bot.DS.AddMessageReaction(m.Message, "⏭️") 43 | 44 | return nil 45 | } 46 | -------------------------------------------------------------------------------- /internal/command/commands/stop.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "github.com/larahfelipe/saturn/internal/bot" 5 | "github.com/larahfelipe/saturn/internal/command" 6 | "github.com/larahfelipe/saturn/internal/player" 7 | ) 8 | 9 | type StopSongCommand struct { 10 | *command.BaseCommand 11 | Bot *bot.Bot 12 | Queue *player.Queue 13 | } 14 | 15 | func NewStopSongCommand(bot *bot.Bot, queue *player.Queue) *StopSongCommand { 16 | return &StopSongCommand{ 17 | BaseCommand: command.NewBaseCommand("stop", "Stop the current song", true), 18 | Bot: bot, 19 | Queue: queue, 20 | } 21 | } 22 | 23 | func (ssc *StopSongCommand) Active() bool { 24 | return ssc.BaseCommand.Active 25 | } 26 | 27 | func (ssc *StopSongCommand) Name() string { 28 | return ssc.BaseCommand.Name 29 | } 30 | 31 | func (ssc *StopSongCommand) Help() string { 32 | return ssc.BaseCommand.Help 33 | } 34 | 35 | func (ssc *StopSongCommand) Execute(m *command.Message) error { 36 | if ssc.Queue.Idle { 37 | ssc.Bot.DS.SendReplyMessage(m.Message, "There is no song playing right now") 38 | return nil 39 | } 40 | 41 | ssc.Queue.PlaybackState <- player.IDLE 42 | ssc.Bot.DS.AddMessageReaction(m.Message, "🛑") 43 | 44 | return nil 45 | } 46 | -------------------------------------------------------------------------------- /internal/command/commands/pause.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "github.com/larahfelipe/saturn/internal/bot" 5 | "github.com/larahfelipe/saturn/internal/command" 6 | "github.com/larahfelipe/saturn/internal/player" 7 | ) 8 | 9 | type PauseSongCommand struct { 10 | *command.BaseCommand 11 | Bot *bot.Bot 12 | Queue *player.Queue 13 | } 14 | 15 | func NewPauseSongCommand(bot *bot.Bot, queue *player.Queue) *PauseSongCommand { 16 | return &PauseSongCommand{ 17 | BaseCommand: command.NewBaseCommand("pause", "Pause the current song", true), 18 | Bot: bot, 19 | Queue: queue, 20 | } 21 | } 22 | 23 | func (psc *PauseSongCommand) Active() bool { 24 | return psc.BaseCommand.Active 25 | } 26 | 27 | func (psc *PauseSongCommand) Name() string { 28 | return psc.BaseCommand.Name 29 | } 30 | 31 | func (psc *PauseSongCommand) Help() string { 32 | return psc.BaseCommand.Help 33 | } 34 | 35 | func (psc *PauseSongCommand) Execute(m *command.Message) error { 36 | if psc.Queue.Idle { 37 | psc.Bot.DS.SendReplyMessage(m.Message, "There is no song playing right now") 38 | return nil 39 | } 40 | 41 | psc.Queue.PlaybackState <- player.PAUSE 42 | psc.Bot.DS.Session.MessageReactionAdd(m.ChannelID, m.ID, "⏸️") 43 | 44 | return nil 45 | } 46 | -------------------------------------------------------------------------------- /internal/command/commands/unpause.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "github.com/larahfelipe/saturn/internal/bot" 5 | "github.com/larahfelipe/saturn/internal/command" 6 | "github.com/larahfelipe/saturn/internal/player" 7 | ) 8 | 9 | type UnpauseSongCommand struct { 10 | *command.BaseCommand 11 | Bot *bot.Bot 12 | Queue *player.Queue 13 | } 14 | 15 | func NewUnpauseSongCommand(bot *bot.Bot, queue *player.Queue) *UnpauseSongCommand { 16 | return &UnpauseSongCommand{ 17 | BaseCommand: command.NewBaseCommand("unpause", "Unpause the current song", true), 18 | Bot: bot, 19 | Queue: queue, 20 | } 21 | } 22 | 23 | func (usc *UnpauseSongCommand) Active() bool { 24 | return usc.BaseCommand.Active 25 | } 26 | 27 | func (usc *UnpauseSongCommand) Name() string { 28 | return usc.BaseCommand.Name 29 | } 30 | 31 | func (usc *UnpauseSongCommand) Help() string { 32 | return usc.BaseCommand.Help 33 | } 34 | 35 | func (usc *UnpauseSongCommand) Execute(m *command.Message) error { 36 | if usc.Queue.Idle { 37 | usc.Bot.DS.SendReplyMessage(m.Message, "There is no song playing right now") 38 | return nil 39 | } 40 | 41 | usc.Queue.PlaybackState <- player.UNPAUSE 42 | usc.Bot.DS.AddMessageReaction(m.Message, "▶️") 43 | 44 | return nil 45 | } 46 | -------------------------------------------------------------------------------- /cmd/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "log" 5 | 6 | "go.uber.org/zap" 7 | 8 | "github.com/larahfelipe/saturn/internal/bot" 9 | "github.com/larahfelipe/saturn/internal/command" 10 | "github.com/larahfelipe/saturn/internal/command/commands" 11 | "github.com/larahfelipe/saturn/internal/config" 12 | "github.com/larahfelipe/saturn/internal/player" 13 | "github.com/larahfelipe/saturn/internal/util" 14 | "github.com/larahfelipe/saturn/internal/youtube" 15 | ) 16 | 17 | func main() { 18 | cfg, err := config.New() 19 | if err != nil { 20 | log.Fatalf("config error: %v", err) 21 | } 22 | 23 | logger, err := util.NewLogger(cfg) 24 | if err != nil { 25 | log.Fatalf("logger initialization error: %v", err) 26 | } 27 | defer logger.Sync() 28 | 29 | bot, err := bot.New(cfg, logger) 30 | if err != nil { 31 | logger.Fatal("bot initialization error", zap.Error(err)) 32 | } 33 | 34 | queue := player.New(cfg, logger) 35 | go queue.Process() 36 | defer queue.Reset() 37 | 38 | yt := youtube.New() 39 | 40 | cmdProcessor, err := command.New(cfg.BotPrefix) 41 | if err != nil { 42 | logger.Fatal("command processor init error", zap.Error(err)) 43 | } 44 | 45 | bot.Prepare(cmdProcessor, 46 | commands.NewHealthCommand(bot), 47 | commands.NewHelpCommand(bot), 48 | commands.NewPauseSongCommand(bot, queue), 49 | commands.NewPingCommand(bot), 50 | commands.NewPlaySongCommand(bot, queue, yt), 51 | commands.NewSkipSongCommand(bot, queue), 52 | commands.NewStopSongCommand(bot, queue), 53 | commands.NewUnpauseSongCommand(bot, queue), 54 | ) 55 | 56 | bot.Run() 57 | } 58 | -------------------------------------------------------------------------------- /internal/player/song.go: -------------------------------------------------------------------------------- 1 | package player 2 | 3 | import ( 4 | "fmt" 5 | "time" 6 | 7 | dg "github.com/bwmarrin/discordgo" 8 | ) 9 | 10 | type Song struct { 11 | Title string 12 | Url string 13 | ArtworkUrl string 14 | Duration string 15 | RequestedBy string 16 | Position int 17 | Stream *Stream 18 | } 19 | 20 | // BuildMessageEmbed builds an embed message for the song. 21 | func (song *Song) BuildMessageEmbed(queued bool) *dg.MessageEmbed { 22 | if queued { 23 | return &dg.MessageEmbed{ 24 | Author: &dg.MessageEmbedAuthor{ 25 | Name: "Queued", 26 | }, 27 | Title: song.Title, 28 | URL: song.Url, 29 | Description: fmt.Sprintf("Added to the queue by <@%s> at position %d", song.RequestedBy, song.Position), 30 | Thumbnail: &dg.MessageEmbedThumbnail{ 31 | URL: song.ArtworkUrl, 32 | }, 33 | Footer: &dg.MessageEmbedFooter{ 34 | Text: fmt.Sprintf("Duration: %s", song.Duration), 35 | }, 36 | Timestamp: time.Now().Format(time.RFC3339), 37 | Color: 0xFFB319, 38 | } 39 | } 40 | 41 | return &dg.MessageEmbed{ 42 | Author: &dg.MessageEmbedAuthor{ 43 | Name: "Now playing", 44 | IconURL: "https://github.com/larahfelipe/saturn/blob/stale-master/src/assets/cd.gif?raw=true", 45 | }, 46 | Title: song.Title, 47 | URL: song.Url, 48 | Description: fmt.Sprintf("Requested by <@%s> Enjoy!", song.RequestedBy), 49 | Thumbnail: &dg.MessageEmbedThumbnail{ 50 | URL: song.ArtworkUrl, 51 | }, 52 | Footer: &dg.MessageEmbedFooter{ 53 | Text: fmt.Sprintf("Duration: %s", song.Duration), 54 | }, 55 | Color: 0x1ED760, 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /internal/command/command.go: -------------------------------------------------------------------------------- 1 | package command 2 | 3 | import ( 4 | "strings" 5 | 6 | dg "github.com/bwmarrin/discordgo" 7 | "github.com/larahfelipe/saturn/internal/common" 8 | ) 9 | 10 | type Message struct { 11 | *dg.MessageCreate 12 | Args []string 13 | } 14 | 15 | type ICommand interface { 16 | Active() bool 17 | Name() string 18 | Help() string 19 | Execute(m *Message) error 20 | } 21 | 22 | type BaseCommand struct { 23 | Active bool 24 | Name string 25 | Help string 26 | } 27 | 28 | type Command struct { 29 | Prefix string 30 | Commands map[string]ICommand 31 | } 32 | 33 | // New creates a new `Command` record. 34 | func New(prefix string) (*Command, error) { 35 | if len(prefix) == 0 { 36 | return nil, common.ErrMissingDiscordBotPrefix 37 | } 38 | 39 | return &Command{ 40 | Prefix: prefix, 41 | Commands: make(map[string]ICommand), 42 | }, nil 43 | } 44 | 45 | // NewBaseCommand creates a new `BaseCommand` record. 46 | func NewBaseCommand(name, help string, active bool) *BaseCommand { 47 | return &BaseCommand{ 48 | Active: active, 49 | Name: name, 50 | Help: help, 51 | } 52 | } 53 | 54 | // Load loads the given bot commands. 55 | func (c *Command) Load(commands ...ICommand) { 56 | for _, command := range commands { 57 | c.Commands[command.Name()] = command 58 | } 59 | } 60 | 61 | // Process handles the command execution. 62 | func (c *Command) Process(s *dg.Session, m *dg.MessageCreate) error { 63 | content := strings.Split(m.Content, " ") 64 | maybeCommandName, maybeCommandArgs := content[0], content[1:] 65 | 66 | command, exists := c.Commands[maybeCommandName] 67 | if !exists || !command.Active() { 68 | return common.ErrUnknownOrUnavailableCommand 69 | } 70 | if err := command.Execute(&Message{m, maybeCommandArgs}); err != nil { 71 | return err 72 | } 73 | 74 | return nil 75 | } 76 | -------------------------------------------------------------------------------- /internal/util/io.go: -------------------------------------------------------------------------------- 1 | package util 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | "os" 7 | "reflect" 8 | "regexp" 9 | 10 | "github.com/larahfelipe/saturn/internal/common" 11 | ) 12 | 13 | // PrintObject logs the given object in the terminal. 14 | func PrintObject(obj interface{}) { 15 | valueOfObj := reflect.ValueOf(obj) 16 | 17 | if valueOfObj.Kind() != reflect.Struct { 18 | fmt.Println(common.ErrInvalidPrintDataType) 19 | return 20 | } 21 | 22 | for i := 0; i < valueOfObj.NumField(); i++ { 23 | field := valueOfObj.Type().Field(i) 24 | fieldValue := valueOfObj.Field(i).Interface() 25 | fmt.Printf("%s: %v\n", field.Name, fieldValue) 26 | } 27 | } 28 | 29 | // GetFileExtFromMime extracts the file format/extension from the given mime type. 30 | func GetFileExtFromMime(mimeType string) string { 31 | re := regexp.MustCompile(`\/([^;\s]+)`) 32 | sm := re.FindStringSubmatch(mimeType) 33 | if len(sm) < 1 { 34 | return "" 35 | } 36 | 37 | return sm[1] 38 | } 39 | 40 | // MkDir creates a directory based on given name. 41 | func MkDir(name string) error { 42 | if err := os.MkdirAll(name, 0755); err != nil { 43 | return err 44 | } 45 | 46 | return nil 47 | } 48 | 49 | // DeleteDir deletes a directory by the given path. 50 | func DeleteDir(dirPath string) error { 51 | if _, err := os.Stat(dirPath); err != nil { 52 | return err 53 | } 54 | 55 | if err := os.RemoveAll(dirPath); err != nil { 56 | return err 57 | } 58 | 59 | return nil 60 | } 61 | 62 | // DeleteFile deletes a file by the given path. 63 | func DeleteFile(filePath string) error { 64 | if _, err := os.Stat(filePath); err != nil { 65 | return err 66 | } 67 | 68 | if err := os.Remove(filePath); err != nil { 69 | return err 70 | } 71 | 72 | return nil 73 | } 74 | 75 | // WriteFile creates a new file based on a readable and a file name. 76 | func WriteFile(readable io.ReadCloser, fileName string) error { 77 | file, err := os.Create(fileName) 78 | if err != nil { 79 | return err 80 | } 81 | defer file.Close() 82 | 83 | if _, err := io.Copy(file, readable); err != nil { 84 | return err 85 | } 86 | 87 | return nil 88 | } 89 | -------------------------------------------------------------------------------- /internal/player/stream.go: -------------------------------------------------------------------------------- 1 | package player 2 | 3 | import ( 4 | "io" 5 | "math" 6 | "os/exec" 7 | 8 | dg "github.com/bwmarrin/discordgo" 9 | "github.com/jonas747/dca" 10 | "go.uber.org/zap" 11 | ) 12 | 13 | type StreamSessionResult struct { 14 | Error error 15 | State PlaybackState 16 | } 17 | 18 | type VoiceChannel struct { 19 | Bitrate int 20 | Connection *dg.VoiceConnection 21 | } 22 | 23 | type StreamSession struct { 24 | Song *Song 25 | VoiceChannel *VoiceChannel 26 | } 27 | 28 | type Stream struct { 29 | Url string 30 | MimeType string 31 | AudioQuality string 32 | Bitrate int 33 | Readable io.ReadCloser 34 | } 35 | 36 | const MAX_BITRATE = 128 // dca only supports bitrate values between 8 and 128 37 | 38 | // Stream streams a song on a voice channel. 39 | func (ss *StreamSession) Stream(streamSessionChan chan StreamSessionResult) { 40 | if _, err := exec.LookPath("ffmpeg"); err != nil { 41 | streamSessionChan <- StreamSessionResult{State: ERR, Error: err} 42 | return 43 | } 44 | 45 | voiceChannelBitrate := ss.VoiceChannel.Bitrate / int(math.Pow10(3)) 46 | options := dca.StdEncodeOptions 47 | options.RawOutput = true 48 | if voiceChannelBitrate <= MAX_BITRATE { 49 | options.Bitrate = voiceChannelBitrate 50 | } else if voiceChannelBitrate >= MAX_BITRATE && ss.Song.Stream.Bitrate >= MAX_BITRATE { 51 | options.Bitrate = MAX_BITRATE 52 | } 53 | 54 | zap.L().Debug("encoding song", zap.Reflect("song", ss.Song), zap.Reflect("encoding_options", options)) 55 | 56 | source, err := dca.EncodeMem(ss.Song.Stream.Readable, options) 57 | if err != nil { 58 | streamSessionChan <- StreamSessionResult{State: ERR, Error: err} 59 | return 60 | } 61 | defer source.Cleanup() 62 | 63 | doneChan := make(chan error) 64 | defer close(doneChan) 65 | streaming := dca.NewStream(source, ss.VoiceChannel.Connection, doneChan) 66 | for { 67 | select { 68 | case streamSessionResult := <-streamSessionChan: 69 | switch streamSessionResult.State { 70 | case UNPAUSE: 71 | streaming.SetPaused(false) 72 | case PAUSE, SKIP: 73 | streaming.SetPaused(true) 74 | case EOF: 75 | return 76 | } 77 | 78 | // dca signals the end of a stream session by sending an io.EOF error 79 | case err := <-doneChan: 80 | if err != nil && err != io.EOF { 81 | streamSessionChan <- StreamSessionResult{State: ERR, Error: err} 82 | } else { 83 | streamSessionChan <- StreamSessionResult{State: EOF} 84 | } 85 | return 86 | } 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /internal/bot/bot.go: -------------------------------------------------------------------------------- 1 | package bot 2 | 3 | import ( 4 | "os" 5 | "os/signal" 6 | "syscall" 7 | "time" 8 | 9 | "go.uber.org/zap" 10 | 11 | "github.com/larahfelipe/saturn/internal/command" 12 | "github.com/larahfelipe/saturn/internal/common" 13 | "github.com/larahfelipe/saturn/internal/config" 14 | "github.com/larahfelipe/saturn/internal/discord" 15 | "github.com/larahfelipe/saturn/internal/player" 16 | ) 17 | 18 | type Bot struct { 19 | Config *config.Config 20 | Logger *zap.Logger 21 | DS *discord.Discord 22 | } 23 | 24 | // New creates a new `Bot` instance. 25 | func New(cfg *config.Config, logger *zap.Logger) (*Bot, error) { 26 | if cfg.BotToken == "" { 27 | return nil, common.ErrMissingDiscordBotToken 28 | } 29 | 30 | ds, err := discord.New(cfg.BotToken) 31 | if err != nil { 32 | return nil, err 33 | } 34 | 35 | return &Bot{ 36 | Config: cfg, 37 | Logger: logger, 38 | DS: ds, 39 | }, nil 40 | } 41 | 42 | // Prepare loads commands and registers a message handler to process them. 43 | func (bot *Bot) Prepare(command *command.Command, commands ...command.ICommand) { 44 | command.Load(commands...) 45 | bot.DS.CommandMessageCreateHandler(command.Process, bot.Config.BotPrefix) 46 | } 47 | 48 | // Run starts the bot by establishing a ws connection to Discord, and waits for shutdown signals. 49 | func (bot *Bot) Run() { 50 | startTime := time.Now() 51 | 52 | if err := bot.DS.Connect(); err != nil { 53 | bot.Logger.Fatal("discord websocket connection error", zap.Error(err)) 54 | } 55 | defer func() { 56 | if err := bot.DS.Disconnect(); err != nil { 57 | bot.Logger.Fatal("discord websocket disconnection error", zap.Error(err)) 58 | } 59 | 60 | bot.Logger.Info("app stopped", zap.String("uptime", time.Since(startTime).String())) 61 | }() 62 | 63 | if bot.Config.BotStatus != "" { 64 | if err := bot.DS.Session.UpdateCustomStatus(bot.Config.BotStatus); err != nil { 65 | bot.Logger.Error("bot activity status update error", zap.Error(err)) 66 | } 67 | } 68 | 69 | zap.S().Infof("bot connected as `%s` and listening for interactions", bot.DS.Session.State.User.Username) 70 | bot.Logger.Info("app started", zap.String("environment", bot.Config.AppEnvironment)) 71 | 72 | sigChan := make(chan os.Signal, 1) 73 | signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM, os.Interrupt) 74 | <-sigChan 75 | } 76 | 77 | // MakeVoiceConnection makes a voice connection to a voice channel. 78 | func (bot *Bot) MakeVoiceConnection(userId string) (*player.Voice, error) { 79 | voiceChannel, err := bot.DS.GetVoiceChannelByUserId(userId) 80 | if err != nil { 81 | return nil, err 82 | } 83 | 84 | voice := &player.Voice{ 85 | Channel: voiceChannel, 86 | } 87 | voice.Connection, err = bot.DS.Session.ChannelVoiceJoin(voiceChannel.GuildID, voiceChannel.ID, false, true) 88 | if err != nil { 89 | return nil, err 90 | } 91 | 92 | return voice, nil 93 | } 94 | -------------------------------------------------------------------------------- /internal/player/queue.go: -------------------------------------------------------------------------------- 1 | package player 2 | 3 | import ( 4 | "sync" 5 | 6 | "go.uber.org/zap" 7 | 8 | dg "github.com/bwmarrin/discordgo" 9 | "github.com/larahfelipe/saturn/internal/config" 10 | ) 11 | 12 | type Voice struct { 13 | Connection *dg.VoiceConnection 14 | Channel *dg.Channel 15 | } 16 | 17 | type Queue struct { 18 | Idle bool 19 | Mutex sync.RWMutex 20 | PlaybackState chan PlaybackState 21 | Voice *Voice 22 | Songs []Song 23 | Config *config.Config 24 | Logger *zap.Logger 25 | } 26 | 27 | type PlaybackState int 28 | 29 | const ( 30 | IDLE PlaybackState = iota 31 | PLAY 32 | PAUSE 33 | UNPAUSE 34 | SKIP 35 | EOF // indicates the end of a stream session 36 | ERR // indicates a stream session error 37 | ) 38 | 39 | func New(cfg *config.Config, logger *zap.Logger) *Queue { 40 | return &Queue{ 41 | Idle: true, 42 | Voice: &Voice{}, 43 | Songs: []Song{}, 44 | PlaybackState: make(chan PlaybackState, 5), 45 | Config: cfg, 46 | Logger: logger, 47 | } 48 | } 49 | 50 | // Shift pops out the first song of the queue. 51 | func (queue *Queue) Shift() *Song { 52 | queue.Mutex.Lock() 53 | defer queue.Mutex.Unlock() 54 | 55 | if len(queue.Songs) == 0 { 56 | return nil 57 | } 58 | 59 | song := queue.Songs[0] 60 | queue.Songs = queue.Songs[1:] 61 | 62 | return &song 63 | } 64 | 65 | // Cleanup resets the queue to its default state. 66 | func (queue *Queue) Reset() { 67 | queue.Mutex.Lock() 68 | defer queue.Mutex.Unlock() 69 | 70 | if queue.Voice.Connection != nil { 71 | if err := queue.Voice.Connection.Disconnect(); err != nil { 72 | queue.Logger.Error("voice connection disconnect error", zap.Error(err)) 73 | } 74 | } 75 | 76 | queue.Voice = &Voice{} 77 | queue.Songs = []Song{} 78 | queue.Idle = true 79 | } 80 | 81 | // Add adds a new song to the queue and returns its index. 82 | func (queue *Queue) Add(song *Song) int { 83 | queue.Mutex.Lock() 84 | defer queue.Mutex.Unlock() 85 | 86 | queue.Songs = append(queue.Songs, *song) 87 | 88 | return len(queue.Songs) - 1 89 | } 90 | 91 | // Process manages the queue's playback state. 92 | func (queue *Queue) Process() { 93 | streamSessionChan := make(chan StreamSessionResult) 94 | 95 | for { 96 | select { 97 | case playbackState := <-queue.PlaybackState: 98 | switch playbackState { 99 | case IDLE: 100 | queue.Reset() 101 | 102 | case PLAY: 103 | song := queue.Shift() 104 | if song != nil { 105 | go (&StreamSession{ 106 | Song: song, 107 | VoiceChannel: &VoiceChannel{ 108 | Connection: queue.Voice.Connection, 109 | Bitrate: queue.Voice.Channel.Bitrate, 110 | }, 111 | }).Stream(streamSessionChan) 112 | } else { 113 | go func() { queue.PlaybackState <- IDLE }() 114 | } 115 | 116 | case PAUSE, UNPAUSE, SKIP: 117 | streamSessionChan <- StreamSessionResult{State: playbackState} 118 | if playbackState == SKIP { 119 | go func() { queue.PlaybackState <- PLAY }() 120 | } 121 | } 122 | 123 | case streamSessionResult := <-streamSessionChan: 124 | if streamSessionResult.State == EOF { 125 | go func() { queue.PlaybackState <- PLAY }() 126 | } else if streamSessionResult.State == ERR { 127 | queue.Logger.Error("stream session result received an error", zap.Error(streamSessionResult.Error)) 128 | go func() { queue.PlaybackState <- IDLE }() 129 | } 130 | } 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /internal/command/commands/play.go: -------------------------------------------------------------------------------- 1 | package commands 2 | 3 | import ( 4 | "fmt" 5 | "math" 6 | 7 | yt "github.com/kkdai/youtube/v2" 8 | "github.com/larahfelipe/saturn/internal/bot" 9 | "github.com/larahfelipe/saturn/internal/command" 10 | "github.com/larahfelipe/saturn/internal/common" 11 | "github.com/larahfelipe/saturn/internal/player" 12 | ) 13 | 14 | type PlaySongCommand struct { 15 | *command.BaseCommand 16 | Bot *bot.Bot 17 | Queue *player.Queue 18 | Youtube *yt.Client 19 | } 20 | 21 | func NewPlaySongCommand(bot *bot.Bot, queue *player.Queue, yt *yt.Client) *PlaySongCommand { 22 | return &PlaySongCommand{ 23 | BaseCommand: command.NewBaseCommand("play", "Play a song", true), 24 | Bot: bot, 25 | Queue: queue, 26 | Youtube: yt, 27 | } 28 | } 29 | 30 | func (psc *PlaySongCommand) Active() bool { 31 | return psc.BaseCommand.Active 32 | } 33 | 34 | func (psc *PlaySongCommand) Name() string { 35 | return psc.BaseCommand.Name 36 | } 37 | 38 | func (psc *PlaySongCommand) Help() string { 39 | return psc.BaseCommand.Help 40 | } 41 | 42 | func (psc *PlaySongCommand) Execute(m *command.Message) error { 43 | if len(m.Args) == 0 { 44 | psc.Bot.DS.SendReplyMessageEmbed(m.Message, psc.Bot.DS.BuildErrorMessageEmbed("Missing song url. Forgot to provide it?")) 45 | return common.ErrMissingYoutubeVideoUrl 46 | } 47 | 48 | videoUrl := m.Args[0] 49 | videoMetadata, err := psc.Youtube.GetVideo(videoUrl) 50 | if err != nil { 51 | psc.Bot.DS.SendReplyMessageEmbed(m.Message, psc.Bot.DS.BuildErrorMessageEmbed("Something went wrong while searching your song. Please, try again later")) 52 | return fmt.Errorf("youtube video request error: %s", err) 53 | } 54 | 55 | videoFormat := videoMetadata.Formats.WithAudioChannels()[0] 56 | audioStream, _, err := psc.Youtube.GetStream(videoMetadata, &videoFormat) 57 | if err != nil { 58 | psc.Bot.DS.SendReplyMessageEmbed(m.Message, psc.Bot.DS.BuildErrorMessageEmbed("Something went wrong while retrieving your song. Please, try again later")) 59 | return fmt.Errorf("youtube stream request error: %s", err) 60 | } 61 | 62 | song := &player.Song{ 63 | Url: videoUrl, 64 | Title: videoMetadata.Title, 65 | ArtworkUrl: videoMetadata.Thumbnails[0].URL, 66 | Duration: videoMetadata.Duration.String(), 67 | Position: len(psc.Queue.Songs) + 1, 68 | RequestedBy: m.Author.ID, 69 | Stream: &player.Stream{ 70 | Url: videoFormat.URL, 71 | MimeType: videoFormat.MimeType, 72 | AudioQuality: videoFormat.AudioQuality, 73 | Bitrate: videoFormat.Bitrate / int(math.Pow10(3)), 74 | Readable: audioStream, 75 | }, 76 | } 77 | psc.Queue.Add(song) 78 | 79 | songMsgEmbed := song.BuildMessageEmbed(!psc.Queue.Idle) 80 | 81 | if psc.Queue.Idle { 82 | if psc.Queue.Voice.Connection == nil { 83 | voice, err := psc.Bot.MakeVoiceConnection(m.Message.Author.ID) 84 | if err != nil { 85 | psc.Bot.DS.SendMessageEmbed(m.Message, psc.Bot.DS.BuildErrorMessageEmbed("Something went wrong while trying to join the party. Please, try again later")) 86 | return fmt.Errorf("voice connection error: %s", err) 87 | } 88 | 89 | psc.Bot.DS.SendMessageEmbed(m.Message, psc.Bot.DS.BuildMessageEmbed(fmt.Sprintf("Yay! Joining the party on <#%s>", voice.Channel.ID))) 90 | 91 | psc.Queue.Voice = voice 92 | } 93 | psc.Queue.Idle = false 94 | psc.Queue.PlaybackState <- player.PLAY 95 | } 96 | 97 | psc.Bot.DS.SendMessageEmbed(m.Message, songMsgEmbed) 98 | 99 | return nil 100 | } 101 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 4 | 5 |

6 | 7 |

8 | 9 | Go 10 | 11 | 12 | discordgo 13 | 14 | 15 | License 16 | 17 |

18 | 19 | ## Table of contents 20 | 21 | - [About](#about) 22 | - [Setup options](#setup-options) 23 | - [Installation](#installation) 24 | - [Prerequisites](#prerequisites) 25 | - [Configuration](#configuration) 26 | - [Option 1: Docker setup (recommended)](#option-1-docker-setup-recommended) 27 | - [Option 2: Manual setup](#option-2-manual-setup) 28 | - [License](#license) 29 | 30 | ## About 31 | 32 | **Saturn** is a **self-hosted Discord bot** built with Go and `discordgo`. Designed for community use, it's lightweight, customizable, and easy to deploy either locally or in the cloud. Hosting platforms like **Heroku** work especially well with Saturn. 33 | 34 | > ⚠️ **Note:** Public listing of this bot on services like [top.gg](https://top.gg) or [discordbotlist.com](https://discordbotlist.com) is **strictly prohibited**. Saturn is intended for **private or community use only**. 35 | 36 | ## Setup options 37 | 38 | You can set up Saturn in two ways: 39 | 40 | 1. **Docker setup (Recommended)**: Provides a standardized environment, ensuring consistent performance across different systems while simplifying deployment. 41 | 42 | 2. **Manual Setup**: Traditional installation directly on your machine. 43 | 44 | ## Installation 45 | 46 | ### Prerequisites 47 | 48 | - Git 49 | - Your Discord bot token (from [Discord Developers Portal](https://discord.com/developers/)) 50 | - For Docker setup: Docker installed on your machine 51 | - For manual setup: Go language and FFmpeg (for music functionality) 52 | 53 | ### Configuration 54 | 55 | 1. Clone the repository: 56 | 57 | ```bash 58 | git clone https://github.com/larahfelipe/saturn.git && cd saturn 59 | ``` 60 | 61 | 2. Set up environment variables: 62 | - Copy `.env.example` to `.env` 63 | - Add your bot token and configure your preferred prefix 64 | 65 | ### Option 1: Docker setup (recommended) 66 | 67 | 1. Verify Docker installation: 68 | 69 | ```bash 70 | docker -v 71 | ``` 72 | 73 | 2. Build the Docker image: 74 | 75 | ```bash 76 | docker build -t saturn . 77 | ``` 78 | 79 | 3. Run the container: 80 | 81 | ```bash 82 | docker run -d --name saturn saturn 83 | ``` 84 | 85 | 4. Verify the container is running: 86 | ```bash 87 | docker ps -a 88 | ``` 89 | The container should appear with status "Up". 90 | 91 | ### Option 2: Manual setup 92 | 93 | 1. Verify Go installation: 94 | 95 | ```bash 96 | go version 97 | ``` 98 | 99 | 2. If using music functionality, install FFmpeg: 100 | 101 | - Ubuntu/Debian: 102 | ```bash 103 | sudo apt install ffmpeg -y 104 | ``` 105 | - Other systems: Refer to the [FFmpeg documentation](https://ffmpeg.org/download.html) 106 | 107 | 3. Run the bot: 108 | ```bash 109 | go run cmd/main.go 110 | ``` 111 | 112 | ## License 113 | 114 | Saturn is licensed under the [GPL-3.0 License](https://github.com/larahfelipe/saturn/blob/master/LICENSE). 115 | -------------------------------------------------------------------------------- /internal/discord/discord.go: -------------------------------------------------------------------------------- 1 | package discord 2 | 3 | import ( 4 | "strings" 5 | "time" 6 | 7 | dg "github.com/bwmarrin/discordgo" 8 | "github.com/larahfelipe/saturn/internal/common" 9 | "go.uber.org/zap" 10 | ) 11 | 12 | type Callback func(s *dg.Session, m *dg.MessageCreate) error 13 | 14 | // CommandMessageCreateHandler handles the message interaction. 15 | func (d *Discord) CommandMessageCreateHandler(callback Callback, prefix string) { 16 | d.Session.AddHandler(func(s *dg.Session, m *dg.MessageCreate) { 17 | if m.Author.Bot || !strings.HasPrefix(m.Content, prefix) { 18 | return 19 | } 20 | 21 | maybeCommand := strings.TrimPrefix(m.Content, prefix) 22 | if len(maybeCommand) == 0 { 23 | zap.L().Error("missing command name", zap.String("author", m.Author.Username)) 24 | return 25 | } 26 | 27 | m.Content = maybeCommand 28 | 29 | if err := callback(s, m); err != nil { 30 | zap.L().Error("runtime error", zap.Error(err), zap.String("interaction", m.Content), zap.String("author", m.Author.Username)) 31 | } 32 | }) 33 | } 34 | 35 | // BuildErrorMessageEmbed builds an embed error message with the given message. 36 | func (d *Discord) BuildErrorMessageEmbed(content string) *dg.MessageEmbed { 37 | return &dg.MessageEmbed{ 38 | Author: &dg.MessageEmbedAuthor{ 39 | Name: "❌ Oops, a wild error appeared! 😱", 40 | IconURL: d.Session.State.User.AvatarURL("256"), 41 | }, 42 | Description: content, 43 | Footer: &dg.MessageEmbedFooter{ 44 | Text: "Please try again later", 45 | }, 46 | Timestamp: time.Now().Format(time.RFC3339), 47 | Color: 0xFB3640, 48 | } 49 | } 50 | 51 | // BuildMessageEmbed builds an embed message with the given message. 52 | func (d *Discord) BuildMessageEmbed(content string) *dg.MessageEmbed { 53 | return &dg.MessageEmbed{ 54 | Author: &dg.MessageEmbedAuthor{ 55 | Name: d.Session.State.User.Username, 56 | IconURL: d.Session.State.User.AvatarURL("256"), 57 | }, 58 | Description: content, 59 | Footer: &dg.MessageEmbedFooter{ 60 | Text: "From space", 61 | }, 62 | Timestamp: time.Now().Format(time.RFC3339), 63 | Color: 0x6E76E5, 64 | } 65 | } 66 | 67 | // SendMessageEmbed sends an embed message to a channel. 68 | func (d *Discord) SendMessageEmbed(m *dg.Message, content *dg.MessageEmbed) { 69 | if _, err := d.Session.ChannelMessageSendEmbed(m.ChannelID, content); err != nil { 70 | zap.L().Error("failed to send message", zap.Error(err)) 71 | } 72 | } 73 | 74 | // SendReplyMessage sends an message to a channel as a reply. 75 | func (d *Discord) SendReplyMessage(m *dg.Message, content string) { 76 | if _, err := d.Session.ChannelMessageSendReply(m.ChannelID, content, m.Reference()); err != nil { 77 | zap.L().Error("failed to send message reply", zap.Error(err)) 78 | } 79 | } 80 | 81 | // SendReplyMessageEmbed sends an embed message to a channel as a reply. 82 | func (d *Discord) SendReplyMessageEmbed(m *dg.Message, content *dg.MessageEmbed) { 83 | if _, err := d.Session.ChannelMessageSendEmbedReply(m.ChannelID, content, m.Reference()); err != nil { 84 | zap.L().Error("failed to send message reply", zap.Error(err)) 85 | } 86 | } 87 | 88 | // AddMessageReaction adds a reaction to a message. 89 | func (d *Discord) AddMessageReaction(m *dg.Message, content string) { 90 | if err := d.Session.MessageReactionAdd(m.ChannelID, m.ID, content); err != nil { 91 | zap.L().Error("failed to add message reaction", zap.Error(err)) 92 | } 93 | } 94 | 95 | // GetVoiceChannelByUserId gets the voice channel based on the given user id. 96 | func (d *Discord) GetVoiceChannelByUserId(userId string) (*dg.Channel, error) { 97 | for _, guild := range d.Session.State.Guilds { 98 | for _, voiceState := range guild.VoiceStates { 99 | if voiceState.UserID == userId { 100 | voiceChannel, err := d.Session.Channel(voiceState.ChannelID) 101 | if err != nil { 102 | return nil, err 103 | } 104 | 105 | return voiceChannel, nil 106 | } 107 | } 108 | } 109 | 110 | return nil, common.ErrUnknownVoiceChannel 111 | } 112 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0= 2 | github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ= 3 | github.com/bitly/go-simplejson v0.5.1 h1:xgwPbetQScXt1gh9BmoJ6j9JMr3TElvuIyjR8pgdoow= 4 | github.com/bitly/go-simplejson v0.5.1/go.mod h1:YOPVLzCfwK14b4Sff3oP1AmGhI9T9Vsg84etUnlyp+Q= 5 | github.com/bwmarrin/discordgo v0.29.0 h1:FmWeXFaKUwrcL3Cx65c20bTRW+vOb6k8AnaP+EgjDno= 6 | github.com/bwmarrin/discordgo v0.29.0/go.mod h1:NJZpH+1AfhIcyQsPeuBKsUtYrRnjkyu0kIVMCHkZtRY= 7 | github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= 8 | github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 9 | github.com/dlclark/regexp2 v1.11.5 h1:Q/sSnsKerHeCkc/jSTNq1oCm7KiVgUMZRDUoRu0JQZQ= 10 | github.com/dlclark/regexp2 v1.11.5/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8= 11 | github.com/dop251/goja v0.0.0-20251201205617-2bb4c724c0f9 h1:3uSSOd6mVlwcX3k5OYOpiDqFgRmaE2dBfLvVIFWWHrw= 12 | github.com/dop251/goja v0.0.0-20251201205617-2bb4c724c0f9/go.mod h1:MxLav0peU43GgvwVgNbLAj1s/bSGboKkhuULvq/7hx4= 13 | github.com/go-sourcemap/sourcemap v2.1.4+incompatible h1:a+iTbH5auLKxaNwQFg0B+TCYl6lbukKPc7b5x0n1s6Q= 14 | github.com/go-sourcemap/sourcemap v2.1.4+incompatible/go.mod h1:F8jJfvm2KbVjc5NqelyYJmf/v5J0dwNLS2mL4sNA1Jg= 15 | github.com/google/pprof v0.0.0-20251208000136-3d256cb9ff16 h1:ptucaU8cwiAc+/jqDblz0kb1ECLqPTeX/qQym8OBYzY= 16 | github.com/google/pprof v0.0.0-20251208000136-3d256cb9ff16/go.mod h1:67FPmZWbr+KDT/VlpWtw6sO9XSjpJmLuHpoLmWiTGgY= 17 | github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= 18 | github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg= 19 | github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= 20 | github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= 21 | github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= 22 | github.com/jonas747/dca v0.0.0-20210930103944-155f5e5f0cc7 h1:Iw1pZVDiq4tY8hO7Wt1D1EqDC0BmMw/bFO/Rdt4gs9Q= 23 | github.com/jonas747/dca v0.0.0-20210930103944-155f5e5f0cc7/go.mod h1:rxjYX9OJU81unMxQDHChU/lAiOhlY9MV+faPX/NmwLk= 24 | github.com/jonas747/ogg v0.0.0-20161220051205-b4f6f4cf3757 h1:Kyv+zTfWIGRNaz/4+lS+CxvuKVZSKFz/6G8E3BKKBRs= 25 | github.com/jonas747/ogg v0.0.0-20161220051205-b4f6f4cf3757/go.mod h1:cZnNmdLiLpihzgIVqiaQppi9Ts3D4qF/M45//yW35nI= 26 | github.com/kkdai/youtube/v2 v2.10.5 h1:22v6qas+/gEhZVmkqAa8fBsLhUsJA5HPDA+mSFkUBwo= 27 | github.com/kkdai/youtube/v2 v2.10.5/go.mod h1:pm4RuJ2tRIIaOvz4YMIpCY8Ls4Fm7IVtnZQyule61MU= 28 | github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= 29 | github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 30 | github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= 31 | github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 32 | go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= 33 | go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= 34 | go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= 35 | go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= 36 | go.uber.org/zap v1.27.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc= 37 | go.uber.org/zap v1.27.1/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= 38 | golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= 39 | golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU= 40 | golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0= 41 | golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= 42 | golang.org/x/net v0.47.0 h1:Mx+4dIFzqraBXUugkia1OOvlD6LemFo1ALMHjrXDOhY= 43 | golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU= 44 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 45 | golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk= 46 | golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= 47 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 48 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 49 | golang.org/x/text v0.32.0 h1:ZD01bjUt1FQ9WJ0ClOL5vxgxOI/sVCNgX1YtKwcY0mU= 50 | golang.org/x/text v0.32.0/go.mod h1:o/rUWzghvpD5TXrTIBuJU77MTaN0ljMWE47kxGJQ7jY= 51 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 52 | gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= 53 | gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= 54 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 55 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 56 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------