harmony_rust_sdk 0.8.0

Rust library to work with the Harmony chat protocol.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

/*!
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/yusdacra/harmony_rust_sdk/Rust)
[![crates.io](https://img.shields.io/crates/v/harmony_rust_sdk)](https://crates.io/crates/harmony_rust_sdk)
[![docs.rs](https://docs.rs/harmony_rust_sdk/badge.svg)](https://docs.rs/harmony_rust_sdk)
[![docs.rs](https://img.shields.io/badge/docs-master-blue)](https://harmonyapp.io/harmony_rust_sdk)
![MSRV](https://img.shields.io/badge/MSRV-current%20stable-red)

Rust implementation of [the Harmony chat protocol](https://github.com/harmony-development).
Currently implements a lightweight client and a client API (powered by [hrpc](https://crates.io/crates/hrpc)),
along with auto generated API via [hrpc-build](https://crates.io/crates/hrpc-build).

## Requirements

- Latest stable Rust and Cargo.
- If you are using Nix, `nix-shell` (or `nix develop` if you use flakes) should
get you covered.
- Otherwise, you'll need to get protobuf and make sure `protoc` is in your `PATH`
env variable.
  - If for some reason `build.rs` fails, make sure to set:
    - `PROTOC` env variable to your `protoc` executable
    - and `PROTOC_INCLUDE` env variable to wherever protobuf include files are
    located, most likely in `/usr/share/include`.

## Examples

- `echo_bot`: Showcases a simple message echo bot that operates in a guild.
It will repost messages whenever someone else posts a message.
- `message_log`: Showcases a simple message log bot that operates in a guild.
It will log messages to the console whenever someone posts a message.
- `cmd_bot`: A more complex bot that responds to "commands". The commands are:
  - r!ping: responds with "Pong! Took X secs."
  - r!hello: responds with "Hello, username!"
  - r!uptime: responds with "Been running for X secs."
- Bot run instructions:
  - Run bots with `GUILD_INVITE=invite cargo run --example example_name`.
  - Make sure the bot has necessary permissions to view channels / send messages etc.

## Crate features

- By default, only a bare-bones common API of all services is generated. You can
customize the crate to your needs by enabling feature(s) listed below:
  - Enable the `client_native` feature for a lightweight client implementation
  that uses `hyper` and works on native platforms.
  - Enable the `client_web` feature for a lightweight client implementation that
  works on web platforms (WASM).
  - Enable the `client_backoff` feature to enable request retrying on ratelimited
  requests.
  - Enable the `gen_client` feature to generate client service code.
  - Enable the `gen_server` feature to generate server service code.
  - (Default) Enable the `gen_chat` feature to generate chat service code.
  - (Default) Enable the `gen_auth` feature to generate auth service code.
  - (Default) Enable the `gen_voice` feature to generate voice service code.
  - (Default) Enable the `gen_mediaproxy` feature to generate media proxy service code.
  - (Default) Enable the `gen_harmonytypes` feature to generate common Harmony types.
  - (Default) Enable the `gen_sync` feature to generate sync service code.
  - (Default) Enable the `gen_emote` feature to generate emote service code.
  - (Default) Enable the `gen_profile` feature to generate profile service code.
  - (Default) Enable the `gen_batch` feature to generate batch service code.

## MSRV

Minimum Supported Rust Version: current stable.

Changing MSRV is not considered a semver-breaking change.

!*/

/// Harmony protocol API.
pub mod api;

#[cfg(feature = "_client_common")]
pub mod client;