https://github.com/vitaliy-ukiru/fsm-telebot
Finite State Machine for Go telebot
https://github.com/vitaliy-ukiru/fsm-telebot
fsm fsm-telegram go-fsm go-fsm-telegram go-telebot state-management telebot telegram-bot-api
Last synced: 5 months ago
JSON representation
Finite State Machine for Go telebot
- Host: GitHub
- URL: https://github.com/vitaliy-ukiru/fsm-telebot
- Owner: vitaliy-ukiru
- License: mit
- Created: 2022-04-02T19:04:20.000Z (about 4 years ago)
- Default Branch: v2.x
- Last Pushed: 2025-04-04T09:08:30.000Z (about 1 year ago)
- Last Synced: 2025-04-04T09:32:51.729Z (about 1 year ago)
- Topics: fsm, fsm-telegram, go-fsm, go-fsm-telegram, go-telebot, state-management, telebot, telegram-bot-api
- Language: Go
- Homepage: https://pkg.go.dev/github.com/vitaliy-ukiru/fsm-telebot/v2
- Size: 323 KB
- Stars: 36
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# fsm-telebot
[](https://pkg.go.dev/github.com/vitaliy-ukiru/fsm-telebot/v2)
[](https://github.com/vitaliy-ukiru/fsm-telebot/actions/workflows/go.yml)
[](https://github.com/vitaliy-ukiru/fsm-telebot/actions/workflows/golangci-lint.yml)
* [fsm-telebot](#fsm-telebot)
* [Overview](#overview)
* [Install](#install)
* [Quick Start](#quick-start)
* [Create telebot.Bot instance](#create-telebotbot-instance)
* [Optionally create group (recommended)](#optionally-create-group-recommended)
* [Init FSM manager](#init-fsm-manager)
* [List of settings](#list-of-settings)
* [Optionally setup middleware for context](#optionally-setup-middleware-for-context)
* [Bind handler via telebot-filter](#bind-handler-via-telebot-filter)
* [telebot-filter/dispatcher](#telebot-filterdispatcher)
* [Init dispatcher](#init-dispatcher)
* [Setups handlers](#setups-handlers)
* [telebot-filter/routing](#telebot-filterrouting)
* [Examples](#examples)
* [Storages](#storages)
* [Memory storage](#memory-storage)
* [Path:](#path-)
* [Redis storage](#redis-storage)
* [Install](#install-1)
* [Add your implementation to list](#add-your-implementation-to-list)
# Overview
Finite State Machine for [telebot](https://gopkg.in/telebot.v4).
Based on [aiogram](https://github.com/aiogram/aiogram) FSM version.
It not a full implementation FSM. It just states manager for telegram bots.
> [!IMPORTANT]
>
> Since v2.0.0-beta.2 supports only telebot@v4 and above
>
> Support for telebot@v3 will be dropped.
This module build over
[github.com/vitaliy-ukiru/telebot-filter](https://pkg.go.dev/github.com/vitaliy-ukiru/telebot-filter).
# Install
```
go get github.com/vitaliy-ukiru/fsm-telebot/v2
```
# Quick Start
## Create telebot.Bot instance
```go
bot, err := tele.NewBot(tele.Settings{
Token: os.Getenv("BOT_TOKEN"),
Poller: &tele.LongPoller{Timeout: 10 * time.Second},
Verbose: *debug,
})
```
## Optionally create group (recommended)
```go
g = bot.Group()
```
## Init FSM manager
```
m := fsm.New(memory.NewStorage())
```
> [!TIP]
>
> Also, you can add optional settings.
> See [fsmopt/manager.go](./fsmopt/manager.go)
### List of settings
- fsmopt.Strategy - Setup custom strategy for user's targeting in storage
- fsmopt.ContextFactory - Setup custom FSM context factory
- fsmopt.FilterProcessor - Setup custom state filter processor
## Optionally setup middleware for context
This middleware needs only for cache fsm.Context
object in telebot.Context.
```
g.Use(m.WrapContext)
```
## Bind handler via telebot-filter
You can use any flow of telebot-filter
### telebot-filter/dispatcher
#### Init dispatcher
```go
dp := dispatcher.NewDispatcher(g)
```
Optionally you can add router object from dispatcher.
#### Setups handlers
These methods work and with router object.
```go
dp.Dispatch(
m.New(
// List of options for fsm.HandlerConfig
// in fsmopt/handler.go
...,
),
)
m.Bind(
dp,
// List of options for fsm.HandlerConfig
// in fsmopt/handler.go
...,
)
m.Handle(
dp,
tele.OnText, // endpoint
MyState, // state filter as fsm.StateMatcher
handler, // handler as fsm.Handler
)
```
### telebot-filter/routing
With this flow available only Manager.New
> [!NOTE]
>
> You don't need to pass endpoint option.
> Because routing package don't look on that.
```
bot.Handle("/start",
routing.New(
// don't specify the endpoint because it doesn't count.
m.New(
...
),
m.New(
...
),
),
)
```
# Examples
See examples in directory [examples](./examples).
# Storages
FSM need storage user state and data for user.
## Memory storage
This storage distributes with fsm-telebot/v2.
It just in-memory storage, that lose data on stop app
### Path:
```
github.com/vitaliy-ukiru/fsm-telebot/v2/pkg/storage/memory
```
## Redis storage
This storage based on redis in distributes separated.
### Install
```
go get github.com/nacknime-official/fsm-telebot-redis-storage/v3
```
## Add your implementation to list
If you want to add you implementation in this list,
then open pull request.