Custom Usage

This is the simplest way to install the SDK, and you can customize all its features. If you only need some features of the SDK, this method is suitable for you.

Download Custom Tool

Just download all the contents of the Custom folder and save.

Usage

1. Open the config.json file
2. Add the features you need
3. Save the file
4. Run python3 create.py
5. The SDK will be generated in the RyhBotPythonSDK folder
6. Move the RyhBotPythonSDK folder to your project directory
7. See Wiki for usage instructions

Option Guide

About Message

• You need to add the message field to declare that you need to use message related functions
• Such as

{
    "message": [
        "send:text",
        "send:markdown",
        "send:image",
        "send:file",
        "edit:text",
        "edit:markdown",
        "edit:image",
        "edit:file",
        "delete",
        "get:before",
        "get:after",
        "board-user:text",
        "board-user:markdown",
        "board-user:html",
        "board-user:cancel",
        "board-global:text",
        "board-global:markdown",
        "board-global:html",
        "board-global:cancel"
    ]
}

• send:text: Send text message
• send:markdown: Send markdown message
• send:image: Send image message
• send:file: Send file message
• edit:text: Edit text message
• edit:markdown: Edit markdown message
• edit:image: Edit image message
• edit:file: Edit file message
• delete: Delete message
• get:before: Get message with before
• get:after: Get message with after
• board-user:text: Send text message to user board
• board-user:markdown: Send markdown message to user board
• board-user:html: Send html message to user board
• board-user:cancel: Cancel user board message
• board-global:text: Send text message to global board
• board-global:markdown: Send markdown message to global board
• board-global:html: Send html message to global board
• board-global:cancel: Cancel global board message

About Server

• You need to add the server field to declare that you need to use server related functions
• Such as

{
    "server": [
        "normal",
        "command",
        "button",
        "all",
        "bot-add",
        "bot-delete",
        "bot-settings",
        "user-join",
        "user-leave"
    ]
}

• normal: Receive normal messages
• command: Receive command messages
• button: Receive button click messages
• all: Receive all messages
• bot-add: Receive bot add messages
• bot-delete: Receive bot delete messages
• bot-settings: Receive bot settings messages
• user-join: Receive user join messages
• user-leave: Receive user leave messages

About Plugin

• You need to add the allow-plugin field to declare that you need to use plugin related functions
• Such as

{
    "allow-plugin": true
}

• When allow-plugin is true, plugin loader and management will be available