User Tools

Site Tools


cherrytelegram

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
cherrytelegram [2024/04/03 23:41] – onslaughtcherrytelegram [2024/05/07 17:43] (current) – onslaught
Line 1: Line 1:
-<html><span style="color:red;font-size:150%;"> This addon requires Cherry core, a free store addon. get it <a href="https://wiki.mmominion.com/doku.php?id=cherrycore">here.</a></span></html>+<html><span style="color:red;font-size:150%;"> This add-on requires Cherry core, a free store add-on. Get it <a href="https://wiki.mmominion.com/doku.php?id=cherrycore">Here</a></span></html>
  
 +<html><span style="color:red;font-size:150%;"> Are you a developer and would like to enable your add-on to send messages to Cherry Telegram? <a href="https://wiki.mmominion.com/doku.php?id=cherrycore">View API Reference</a></span></html>
  
-{{::cherry:telegram_addon_logo.png?150|}} 
  
 +
 +{{::cherry:telegram_addon_logo.png?150|}}
  
 ====== Cherry Telegram ======  ====== Cherry Telegram ====== 
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're in your free company, your party, linkshell, or any other chat mode in the game.   * Use the same commands you do in-game to talk to whoever you want, whether they're in your free company, your party, linkshell, or any other chat mode in the game.
   * 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' add-ons to leverage the Telegram engine via registered mods. (Requires implementation by the add-ons author)   * Full support for other authors' add-ons to leverage the Telegram engine via registered mods. (Requires implementation by the add-ons author)
  
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://core.telegram.org/bots/features#creating-a-new-bot|Step-by-step Telegram bot creation]]. The username and description of the bot can be anything you choose and do not affect the operation of the add-on. The important part of this is to get the bot token. Keep the bot token safe as we will be using it in later steps.+Follow this link to create your bot [[https://core.telegram.org/bots/features#creating-a-new-bot|Step-by-step Telegram bot creation]]. The username and description of the bot can be anything you choose and do not affect the operation of the add-on. The important part of this is to get the bot token. Keep the bot token safe, as we will be using it in later steps.
  
-Once the bot is created and you have obtained the bot token and while you're still interacting with @botfather, use the <code>/setjoingroups</code> command to turn off group access. Cherry Telegram will only respond to chats directly from the Telegram username that you provide to it, so there's no worry that other users will be able to communicate with your game or see your in-game messages, But using the set join groups command will ensure that other users don't try to add it to a group and interact with it in that fashion.+Once the bot is created, and you have obtained the bot token and while you're still interacting with @botfather, use the <code>/setjoingroups</code> command to turn off group access. Cherry Telegram will only respond to chats directly from the Telegram username that you provide to it, so there's no worry that other users will be able to communicate with your game or see your in-game messages, But using the set join groups command will ensure that other users don't try to add it to a group and interact with it in that fashion.
 {{:cherry:botfather.png?400|}} {{:cherry:botfather.png?400|}}
  
  
-== 2. Addon Installation / Initial Settings ==+=== 2. Add-on Installation / Initial Settings ===
  
-  - Install both this addon as well as [[https://wiki.mmominion.com/doku.php?id=cherrycore|Cherry Core]].+  - Install both this add-on and [[https://wiki.mmominion.com/doku.php?id=cherrycore|Cherry Core]].
   - Enter the game.   - Enter the game.
-  - Open the addon by going into MMOminions main menu and selecting "Cherry Telegram"+  - Open the add-on by going into MMOminion main menu and selecting "Cherry Telegram"
  
 {{:cherry:cherrymenu.png?400|}} {{:cherry:cherrymenu.png?400|}}
Line 61: Line 63:
   - Enable "Listen for Telegram commands"   - Enable "Listen for Telegram commands"
   - Enable "send messages to Telegram"   - Enable "send messages to Telegram"
-  - Not required but I recommend that you enable "Auto-connect to last chat instance"+  - Not required, but I recommend that you enable "Auto-connect to last chat instance"
  
-Once those settings are entered in-game, go into Telegram and start a conversation with your bot. You do this by entering the search section and typing in an "@" and your bots username: Example "@ffxivchattingbot". Send the +Once those settings are entered in-game, go into Telegram and start a conversation with your bot. You do this by entering the search section and typing in an "@" and your bots' username: Example "@ffxivchattingbot". Send the 
 <code> /start </code> <code> /start </code>
-Command to your bot to start interacting with the game client. If you don't enable "Auto-connect to last chat instance" then you will need to send the start command every time you reopen the game.+Command your bot to start interacting with the game client. If you don't enable "Auto-connect to last chat instance" then you will need to send the start command every time you reopen the game.
  
-Once the bot has been connected for a few minutes you should see a list of commands appear in telegram:+Once the bot has been connected for a few minutes, you should see a list of commands appear in telegram:
  
 {{:cherry:commandmenu.png?400|}} {{:cherry:commandmenu.png?400|}}
 +
 +==== Multi-Boxing ====
 +Cherry Telegram supports multi-boxing via multiple telegram bot tokens. Telegram does not allow multiple clients to control a single bot, so you will need a separate Telegram bot token for each instance of Cherry Telegram. Use the profile manager in mmominion to ensure that the bot token is unique for each profile.
  
 ==== Mod Setup ====  ==== Mod Setup ==== 
  
-Any 3rd party add-on developer can develop an add-on that connects to Cherry Core. That add-on can then send and receive messages and commands from any cherry communication add-on. Cherry Core provides a simple interface for allowing the 3rd party add-on to communicate and at the same time gives the end user full control over what messages they receive and to what platform the messages are routed.+Any 3rd party add-on developer can develop an add-on that connects to Cherry Core. That add-on can then send and receive messages and commands from any cherry communication add-on. Cherry Core provides a simple interface for allowing the 3rd party add-on to communicate, and at the same time gives the end user full control over what messages they receive and to what platform the messages are routed.
  
 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 as well as at least one communication client installed and  configured the sample code should work out of the box.+Download {{ :cherry:modchattest_-_5.6.24.zip |}} And install it in Mmominion in the LuaMods folder. As long as you have Cherry Core installed and at least one communication client installed and configured, the sample code should work out of the box.
  
-== CherryConnect API ==+=== Cherry Connect API === 
 +Are you a developer and would like to enable your add-on to send messages to Cherry Telegram? View the API Reference [[cherrycore#Cherry Connect API Referance|Here]] 
  
-The Cherry Connect API is fairly simple and is accessed by the global variable  
  
-<code> Cherry Connect </code>+==== Troubleshooting ==== 
  
-Cherry Connect functions are explained below:+If you have any questions or need help, please visit the Cherry discord server: 
 +[[https://discord.gg/NTnZZAsjHj|Cherry Discord]]
  
 +===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/receive messages and commands with a user's installed communication clients. 
-<code> local CherryConnect.Register(author, cmdFunc, modName, desc)</code> 
  
-  * **author** - //required// 
-    * The name of the author of the mod  
-  * **cmdFunc** - //required// 
-    * The function that will be called anytime the user communicates with one of the clients 
-  * **modName** - //required// 
-    * This is the name of the mod and will also become the command that the user will use to communicate with the mod 
-  * **desc** - //required// 
-    * 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: 
-<code> 
-{ 
-   mode = p_mods.result_modes.error, 
-   err_code = error.error_code, 
-   message = message, 
-} 
-</code> 
  
-On success: 
-<code> 
-{ 
-   mode = "new_id", 
-   message = "MOD_ID", 
-} 
-</code> 
  
  
  
-//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: 
-<code> CherryConnect.Unregister(mod_id)</code> 
-Unregisters the mod from Cherry Connect 
- 
-  * **id** - //required// 
-    * The mod id that is being unregistered 
- 
-== CherryConnect.Message == 
- 
-Usage: 
-<code> CherryConnect.Message(mod_id, message)</code> 
- 
-== CherryConnect.MessageOptions == 
- 
-Usage: 
-<code> CherryConnect.MessageOptions(mod_id, options, message, callback_func)</code> 
- 
-== CherryConnect.MessageResponse == 
- 
-Usage: 
-<code> CherryConnect.MessageResponse(mod_id, response_id, message)</code> 
- 
- 
-== Results Class == 
- 
-<code>  
-result_modes = { 
-   new_id = "new_id", 
-   success = "success", 
-   error = "error", 
-   message = "message", 
-} 
-</code> 
- 
- 
- 
- 
- 
-==== Troubleshooting ====  
- 
-If you have any questions or need help, please visit the Cherry discord server: 
-[[https://discord.gg/NTnZZAsjHj|Cherry Discord]] 
cherrytelegram.1712187680.txt.gz · Last modified: 2024/04/03 23:41 by onslaught

Page Tools