Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 4.06 KB

ReadMe.md

File metadata and controls

83 lines (58 loc) · 4.06 KB
Raw

Talkie - Build Bots Once, Deploy Everywhere

Talkie is under active development. The underlying C# framework libraries is subject to change.

Talkie is a framework for creating bots across messaging platforms. Write code once, deploy everywere (for Telegram, Discord, and more). Also, its lightweight and modular design, parallel processing and native AOT compilation, keep your bots blazing fast with minimal memory usage.

Features

  • Fast and Lightweight: Talkie is designed to be fast and lightweight, making it ideal for use in resource-constrained environments or high-traffic, large-scale bots.
  • Native-AOT Support (Latest .NET 8): Talkie provides native Ahead-of-Time (AOT) compilation support with the latest .NET 8 framework, enabling developers to compile bots to native code for enhanced performance and memory efficiency.
  • Parallel Processing: Talkie is optimized to leverage multi-core processors, empowering developers to create bots capable of handling multiple messages concurrently.
  • OOP and Functional Programming: Talkie offers flexibility by supporting both object-oriented and functional programming paradigms, allowing developers to choose the style that best aligns with their preferences and project requirements.
  • Self-Contained and Independent: Talkie is self-contained and does not rely on external libraries. This eliminates compatibility concerns, reduces the overall footprint, and simplifies deployment.
  • Cross-Platform Compatibility: Talkie is engineered for cross-platform compatibility, enabling developers to write code once and deploy it seamlessly across diverse bot platforms, including Telegram, Discord, and more.
  • Extensible Architecture: Talkie is designed with extensibility in mind, making it easy for developers to add new features, functionalities, and expand platform support as needed.
  • Comprehensive Functionality: Talkie offers a wide array of features, and managing complex branched code for different bot platforms, all while simplifying code that would be more cumbersome on other platforms.

Usage

Add the Falko Team NuGet Repository:

Open your terminal and execute the following command, replacing placeholders with your GitHub credentials:

dotnet nuget add source "https://nuget.pkg.github.com/falko-team/index.json"
    --name falko-team
    --store-password-in-clear-text
    --username $YOUR_GITHUB_USERNAME
    --password $YOUR_GITHUB_ACCESS_TOKEN

Install the Talkie Platforms Package:

If you're using Telegram, install the Talkie Telegram Platform package:

dotnet add package Falko.Talkie.Platforms.Telegram

Explore the Examples:

To get started quickly, check out the Examples folder in the Talkie repository for illustrative code samples and usage demonstrations.

Or explore Simple Wallet Bot (Rider Coin Bot)!

Or watch simple example of code:

await using var disposables = new ReverseDisposableScope();

var flow = new SignalFlow()
    .DisposeWith(disposables);

var unobservedExceptionTask = flow.TakeUnobservedExceptionAsync()

flow.Subscribe<MessagePublishedSignal>(signals => signals
    .SkipSelfPublish()
    .SkipOlderThan(TimeSpan.FromMinutes(1))
    .Where(signal => signal
        .Message
        .GetText()
        .ToLowerInvariant()
        .Contains("hello"))
    .HandleAsync(context => context
        .ToMessageController()
        .PublishMessageAsync("hi")
        .AsValueTask()))
    .UnsubscribeWith(disposables);

await flow.ConnectTelegramAsync("YOUR_TOKEN")
    .DisposeAsyncWith(disposables);

throw await unobservedExceptionTask;

License

This project is licensed under the BSD 2-Clause License.

Contributions are welcome!

© 2024, Falko Team