User Tools

Site Tools



cherrytelegram

This is an old revision of the document!


This addon requires Cherry core, a free store addon. get it here.

Cherry Telegram

Seamlessly connect Final Fantasy XIV's chat system with your Telegram account, ensuring you never miss a beat, even when you're not in the game. Type messages directly into Telegram, and watch as they're instantly relayed into the game's chat, allowing you to communicate with your teammates as if you were there. Plus, stay updated with real-time notifications of in-game events and conversations.

Features

Full chat log support
  • Transfers all chat messages to telegram
  • Filter between all messages or only messages from the categories you want to see
  • Auto converts text emojis from chat to telegram emojis
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.
  • Activate emotes remotely, make your character dance from your cell phone.
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.
  • Full support for custom Telegram response buttons.
  • Full custom registered command 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)

First-Time Setup

This add-on utilizes Telegram's bot technology to transfer messages back and forth to the game. Telegram is free and creating a bot is free as well as easy. No coding skills are needed. Follow the instructions carefully to ensure that you don't have any issues.

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.

2. Create a Telegram Bot

Follow this link to create your 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

/setjoingroups

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.

2. Addon Installation / Initial Settings
  1. Install both this addon as well as Cherry Core.
  2. Enter the game.
  3. Open the addon by going into MMOminions main menu and selecting “Cherry Telegram”

  1. Enter your bot token exactly how you got it with no extra characters or trailing spaces.
  2. Enter your Telegram username. THIS IS CASE-SENSITIVE
  3. Enable “Listen for Telegram commands”
  4. Enable “send messages to Telegram”
  5. 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

 /start 

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.

Once the bot has been connected for a few minutes you should see a list of commands appear in telegram:

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.

Follow the instructions below to build your first mod.

Download 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.

CherryConnect API

The Cherry Connect API is fairly simple and is accessed by the global variable

 CherryConnect 

There are five functions in CherryConnect:

CherryConnect.Register

Usage:

 local CherryConnect.Register(author, cmdFunc, modName, desc)
  • author - required
    • The name of the author of the mod
  • cmdFunc - required
    • The function that will be called anytime the user communicates from 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

{
		mode = p_mods.result_modes.error,
		err_code = error.error_code,
		message = message,
	}

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.

CherryConnect.Unregister

Usage:

 CherryConnect.Unregister = function(id)
CherryConnect.Message

Usage:

 CherryConnect.Message(mod_id, message)
CherryConnect.MessageOptions

Usage:

 CherryConnect.MessageOptions(mod_id, options, message, callback_func)
CherryConnect.MessageResponse

Usage:

 CherryConnect.MessageResponse(mod_id, response_id, message)
Results Class
 
result_modes = {
   new_id = "new_id",
   success = "success",
   error = "error",
   message = "message",
}

Troubleshooting

If you have any questions or need help, please visit the Cherry discord server: Cherry Discord

cherrytelegram.1712186853.txt.gz · Last modified: 2024/04/03 23:27 by onslaught