This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
cherrytelegram [2024/04/03 23:41] – onslaught | cherrytelegram [2024/05/06 22:00] – onslaught | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | < | + | < |
+ | |||
+ | < | ||
- | {{:: | ||
Line 12: | Line 14: | ||
==== Features ==== | ==== Features ==== | ||
- | == Full chat log support == | + | === Full chat log support |
* Transfers all chat messages to telegram | * Transfers all chat messages to telegram | ||
* Filter between all messages or only messages from the categories you want to see | * Filter between all messages or only messages from the categories you want to see | ||
Line 18: | Line 20: | ||
- | == Full messaging support == | + | === Full messaging support |
* Use the same commands you do in-game to talk to whoever you want, whether they' | * Use the same commands you do in-game to talk to whoever you want, whether they' | ||
* Activate emotes remotely, make your character dance from your cell phone. | * Activate emotes remotely, make your character dance from your cell phone. | ||
- | == Leverage Telegrams Full Power == | + | === Leverage Telegrams Full Power === |
* In-game links are automatically converted to website previews in the telegram client, bringing to life links shared by everyone around you. | * In-game links are automatically converted to website previews in the telegram client, bringing to life links shared by everyone around you. | ||
* Full support for custom Telegram response buttons. | * Full support for custom Telegram response buttons. | ||
Line 29: | Line 31: | ||
- | == Add-on Support == | + | === Add-on Support |
* Full support for other authors' | * Full support for other authors' | ||
Line 37: | Line 39: | ||
- | == 1. Create a Telegram Account == | + | === 1. Create a Telegram Account |
This add-on requires that you have a Telegram account. Telegram accounts are free and easy to sign up for. | This add-on requires that you have a Telegram account. Telegram accounts are free and easy to sign up for. | ||
- | == 2. Create a Telegram Bot == | + | === 2. Create a Telegram Bot === |
Follow this link to create your bot [[https:// | Follow this link to create your bot [[https:// | ||
Line 49: | Line 51: | ||
- | == 2. Addon Installation / Initial Settings == | + | === 2. Addon Installation / Initial Settings |
- Install both this addon as well as [[https:// | - Install both this addon as well as [[https:// | ||
Line 70: | Line 72: | ||
{{: | {{: | ||
+ | |||
+ | ==== Multi-Boxing ==== | ||
+ | Cherry Telegram supports multi-boxing via multiple bots. Telegram does not allow multiple clients to control a single bot, so you will need a separate Telegram bot token setup for each instance of cherry telegram. | ||
==== Mod Setup ==== | ==== Mod Setup ==== | ||
Line 77: | Line 82: | ||
Follow the instructions below to build your first mod. | Follow the instructions below to build your first mod. | ||
- | Download {{ :cherry:cherry_modchattest.zip |}} And install it in Mmo Minion in the LuaMods folder. As long as you have Cherry Core installed | + | Download {{ :cherry:modchattest_-_5.6.24.zip |}} And install it in Mmo Minion in the LuaMods folder. As long as you have Cherry Core installed |
- | == CherryConnect API == | + | === CherryConnect API === |
+ | Are you a developer and would like enable your addon to send messages to Cherry Telegram? View the API Reference [[cherrycore# | ||
- | The Cherry Connect API is fairly simple and is accessed by the global variable | ||
- | < | + | ==== Troubleshooting ==== |
- | Cherry | + | If you have any questions or need help, please visit the Cherry |
+ | [[https:// | ||
+ | ===Debug Level=== | ||
+ | By default only severe errors are posted to the console. If you're having issues and you can't figure them out you may want to raise the debug level in the settings. Doing this will result in many more messages being posted to the console and may lead to a solution to your problem. | ||
- | == CherryConnect.Register == | ||
- | Usage: | ||
- | Registers a mod through the Cherry Connect platform to enable an add-on to send/ | ||
- | < | ||
- | * **author** - // | ||
- | * The name of the author of the mod | ||
- | * **cmdFunc** - // | ||
- | * The function that will be called anytime the user communicates with one of the clients | ||
- | * **modName** - // | ||
- | * This is the name of the mod and will also become the command that the user will use to communicate with the mod | ||
- | * **desc** - // | ||
- | * This helps the user understand what the purpose of the mod is and is visible in the mod section of each communication client | ||
- | **returns** | ||
- | On errors: | ||
- | < | ||
- | { | ||
- | mode = p_mods.result_modes.error, | ||
- | | ||
- | | ||
- | } | ||
- | </ | ||
- | On success: | ||
- | < | ||
- | { | ||
- | mode = " | ||
- | | ||
- | } | ||
- | </ | ||
- | //Notes// | ||
- | The mod name cannot conflict with any other mod or command. Mods do not share a 1 to 1 relationship with an add-on, so a single add-on can register multiple mods. | ||
- | **MOD_ID** Will be used in all the other API calls to identify which mod is making the call. The **MOD_ID** must be saved for as long as Cherry Core is not unloaded or until the mod is unregistered. Once the mod is unregistered you must re-register the mod to access a new **MOD_ID** | ||
- | |||
- | |||
- | |||
- | == CherryConnect.Unregister == | ||
- | |||
- | Usage: | ||
- | < | ||
- | Unregisters the mod from Cherry Connect | ||
- | |||
- | * **id** - // | ||
- | * The mod id that is being unregistered | ||
- | |||
- | == CherryConnect.Message == | ||
- | |||
- | Usage: | ||
- | < | ||
- | |||
- | == CherryConnect.MessageOptions == | ||
- | |||
- | Usage: | ||
- | < | ||
- | |||
- | == CherryConnect.MessageResponse == | ||
- | |||
- | Usage: | ||
- | < | ||
- | |||
- | |||
- | == Results Class == | ||
- | |||
- | < | ||
- | result_modes = { | ||
- | | ||
- | | ||
- | error = " | ||
- | | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ==== Troubleshooting ==== | ||
- | |||
- | If you have any questions or need help, please visit the Cherry discord server: | ||
- | [[https:// |