lowbot

package module
v1.5.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2023 License: MIT Imports: 13 Imported by: 1

README

lowbot

🤖 LowBot is a Go project on GitHub that simplifies bot creation by automatically generating bot journeys from a YAML script. It offers extensive customization options, making it highly versatile and adaptable.

🤔 Why LowBot?

  • 📚 Simple and Self-Explanatory Scripting:

    LowBot follows a straightforward and intuitive YAML script format, making it easy to understand and modify for creating bot journeys.

  • 🧩 Extensibility for Custom Business Rules:

    LowBot offers extensive flexibility, allowing users to define their own custom actions and implement unique business rules tailored to their specific requirements.

  • 📡 Expandable Bot Channels:

    With LowBot, users can seamlessly integrate and implement their own channels, empowering them to connect the bot with various platforms and communication channels of their choice.

📦 Install

go get github.com/chrissgon/lowbot

🚀 Quick Start

Start a bot with Telegram and local persist

import "github.com/chrissgon/lowbot"

flow, _ := lowbot.NewFlow("your_flow.yaml")
channel, _ := lowbot.NewTelegram()
persist, _ := lowbot.NewLocalPersist()

lowbot.StartBot(flow, channel, persist)

Start a bot with Discord and custom actions

import "github.com/chrissgon/lowbot"

myActions := lowbot.ActionsMap{
    "Custom": func(flow *lowbot.Flow, channel lowbot.Channel) (bool, error) {
        // your rules
        next := false
        return next, nil
    },
}

lowbot.SetCustomActions(myActions)

flow, _ := lowbot.NewFlow("your_flow.yaml")
channel, _ := lowbot.NewDiscord()
persist, _ := lowbot.NewLocalPersist()

lowbot.StartBot(flow, channel, persist)

You can create your Channel or Persist by implementing their interfaces

import "github.com/chrissgon/lowbot"

func MyNewChannel () lowbot.Channel {
  // implements Channel
}

func MyNewPersist () lowbot.Persist {
  // implements Persist
}

flow, _ := lowbot.NewFlow("your_flow.yaml")

// And you can pass in the StartBot
lowbot.StartBot(flow, MyNewChannel(), MyNewPersist())

📚 Documentation

Read all documentation in docs folder.

🌎 Global Variables

When you run this project, you can adjusts the following environment variables.

Debug: Show debug => default: true

EnableLocalPersist: Enable local persist => default: true

🔒 Environment Variables

When you run this project, you need set the following environment variables.

  • When you to use Telegram:
    TELEGRAM_TOKEN: Telegram bot token.
  • When you to use Discord:
    DISCORD_TOKEN: Discord bot token.

💪🏻 Contribution

This project is open source and welcomes community contributions. Feel free to fork, implement improvements, and submit a pull request. Every contribution is valued and appreciated!

We hope that lowbot proves useful to you and enhances your manga reading experience. Feel free to explore the source code, provide feedback, and report any issues you encounter.

💚 Authors

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Debug = true
View Source 
var EnableLocalPersist = true

Functions

func ActionAudio 

func ActionAudio(flow *Flow, channel Channel) (bool, error)

func ActionButton 

func ActionButton(flow *Flow, channel Channel) (bool, error)

func ActionDocument 

func ActionDocument(flow *Flow, channel Channel) (bool, error)

func ActionImage 

func ActionImage(flow *Flow, channel Channel) (bool, error)

func ActionInput 

func ActionInput(flow *Flow, channel Channel) (bool, error)

func ActionText 

func ActionText(flow *Flow, channel Channel) (bool, error)

func ActionVideo 

func ActionVideo(flow *Flow, channel Channel) (bool, error)

func ActionWait added in v1.5.2 

func ActionWait(flow *Flow, channel Channel) (bool, error)

func FormatTestError 

func FormatTestError(expect, have interface{}) string

func Int64ToString 

func Int64ToString(number int64) string

func IsURL 

func IsURL(str string) bool

func NewError added in v1.4.0 

func NewError(fn string, err error) error

func ParseTemplate 

func ParseTemplate(texts []string) string

func RunAction 

func RunAction(flow *Flow, channel Channel) (bool, error)

func RunActionError 

func RunActionError(flow *Flow, channel Channel) (bool, error)

func SetCustomActions added in v1.1.0 

func SetCustomActions(custom ActionsMap)

func StartBot 

func StartBot(base Flow, channel Channel, persist Persist) error

func StringToInt64 

func StringToInt64(str string) int64

Types

type ActionsMap 

type ActionsMap map[string]func(flow *Flow, channel Channel) (bool, error)

type Channel 

type Channel interface {
	SendAudio(Interaction) error
	SendButton(Interaction) error
	SendDocument(Interaction) error
	SendImage(Interaction) error
	SendText(Interaction) error
	SendVideo(Interaction) error
	Next(chan Interaction)
}

func NewDiscord added in v1.4.0 

func NewDiscord() (Channel, error)

func NewTelegram 

func NewTelegram() (Channel, error)

type Discord added in v1.4.0 

type Discord struct {
	// contains filtered or unexported fields
}

func (*Discord) Next added in v1.4.0 

func (ds *Discord) Next(in chan Interaction)

func (*Discord) RespondInteraction added in v1.4.0 

func (ds *Discord) RespondInteraction(in *discordgo.Interaction)

func (*Discord) SendAudio added in v1.4.0 

func (ds *Discord) SendAudio(in Interaction) error

func (*Discord) SendButton added in v1.4.0 

func (ds *Discord) SendButton(in Interaction) error

func (*Discord) SendDocument added in v1.4.0 

func (ds *Discord) SendDocument(in Interaction) error

func (*Discord) SendFile added in v1.4.0 

func (ds *Discord) SendFile(sessionID, text, path string) error

func (*Discord) SendImage added in v1.4.0 

func (ds *Discord) SendImage(in Interaction) error

func (*Discord) SendText added in v1.4.0 

func (ds *Discord) SendText(in Interaction) error

func (*Discord) SendVideo added in v1.4.0 

func (ds *Discord) SendVideo(in Interaction) error

type Flow 

type Flow struct {
	SessionID string
	Name      string `yaml:"name"`
	Steps     Steps  `yaml:"steps"`
	Current   *Step
}

func NewFlow 

func NewFlow(path string) (Flow, error)

func (*Flow) End 

func (flow *Flow) End() *Flow

func (*Flow) IsEnd 

func (flow *Flow) IsEnd() bool

func (*Flow) Next 

func (flow *Flow) Next(in Interaction) *Flow

func (*Flow) NoHasNext added in v1.4.0 

func (flow *Flow) NoHasNext() bool

func (*Flow) Start 

func (flow *Flow) Start()

type Interaction 

type Interaction struct {
	SessionID  string                `json:"sessionID"`
	Type       InteractionType       `json:"type"`
	Parameters InteractionParameters `json:"parameters"`
	Custom     map[string]any        `json:"custom"`
}

func NewInteractionMessageAudio 

func NewInteractionMessageAudio(sessionID string, audio string, text string) Interaction

func NewInteractionMessageButton 

func NewInteractionMessageButton(sessionID string, buttons []string, text string) Interaction

func NewInteractionMessageDocument 

func NewInteractionMessageDocument(sessionID string, document string, text string) Interaction

func NewInteractionMessageImage 

func NewInteractionMessageImage(sessionID string, image string, text string) Interaction

func NewInteractionMessageText 

func NewInteractionMessageText(sessionID string, text string) Interaction

func NewInteractionMessageVideo 

func NewInteractionMessageVideo(sessionID string, video string, text string) Interaction

type InteractionParameters 

type InteractionParameters StepParameters

type InteractionType 

type InteractionType string
const (
	MESSAGE InteractionType = "message"
	EVENT                   = "event"
)

type Local added in v1.4.0 

type Local struct {
	Sessions map[string]*Flow
}

func (*Local) Get added in v1.4.0 

func (loc *Local) Get(sessionID string) (*Flow, error)

func (*Local) Load added in v1.4.0 

func (loc *Local) Load() error

func (*Local) Set added in v1.4.0 

func (loc *Local) Set(flow *Flow) error

type Persist added in v1.4.0 

type Persist interface {
	Set(flow *Flow) error
	Get(sessionID string) (*Flow, error)
}

func NewLocalPersist added in v1.4.0 

func NewLocalPersist() (Persist, error)

type Step 

type Step struct {
	Action     string            `yaml:"action"`
	Next       map[string]string `yaml:"next"`
	Parameters StepParameters    `yaml:"parameters"`
	Responses  []Interaction
}

func (*Step) AddResponse added in v1.4.0 

func (step *Step) AddResponse(in Interaction)

func (*Step) GetLastResponse added in v1.4.2 

func (step *Step) GetLastResponse() Interaction

func (*Step) GetLastResponseText added in v1.4.2 

func (step *Step) GetLastResponseText() string

type StepParameters 

type StepParameters struct {
	Audio    string   `yaml:"audio" json:"audio"`
	Buttons  []string `yaml:"buttons" json:"buttons"`
	Document string   `yaml:"document" json:"document"`
	Image    string   `yaml:"image" json:"image"`
	Text     string   `yaml:"text" json:"text"`
	Texts    []string `yaml:"texts"`
	Video    string   `yaml:"video" json:"video"`
}

type Steps 

type Steps map[string]*Step

type Telegram 

type Telegram struct {
	// contains filtered or unexported fields
}

func (*Telegram) Next 

func (tg *Telegram) Next(in chan Interaction)

func (*Telegram) SendAudio 

func (tg *Telegram) SendAudio(in Interaction) error

func (*Telegram) SendButton 

func (tg *Telegram) SendButton(in Interaction) error

func (*Telegram) SendDocument 

func (tg *Telegram) SendDocument(in Interaction) error

func (*Telegram) SendImage 

func (tg *Telegram) SendImage(in Interaction) error

func (*Telegram) SendText 

func (tg *Telegram) SendText(in Interaction) error

func (*Telegram) SendVideo 

func (tg *Telegram) SendVideo(in Interaction) error

Source Files

View all Source files

Directories

Path Synopsis
docs
examples/dungeon
examples/hello
examples/pingpong
examples/tabnews

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.