<WRAP center round alert 40%>
This addon has NO requirements and is standalone.
</WRAP>

== Cypher AI Chat ==

Cypher AI Chat is an addon designed to enhance your gaming experience with advanced automation, chat management, and custom notification features. This toolkit integrates AI-driven responses, Discord alerts, player detection, GM monitoring, and various hack functionalities to streamline and protect your gameplay.

=== Features ===

==== AI Chat Integration ====

  * **Use AI-generated replies for in-game chat, powered by OpenAI.** (Requires your own OpenAI API Key)
  * **Customize AI personality** to match your preferred interaction style.
  * Supports multiple chat types, including **Say, Shout, Tell, Party, and more**.
  * **Blacklist specific players** to prevent AI responses to their messages.
  * **Adjustable reply delays** to ensure natural conversation pacing.
  * Option to **consolidate multiple messages** into a single AI response.
  * Configure **maximum token limits** for AI replies.
  * Configure **Discord notifications** by setting up webhook URLs to send messages detected by this addon to Discord channels.

<WRAP left tip 100%>
**Testing AI Responses without your Character Name Blacklisted**

To effectively test AI responses and refine interaction styles, your character name has been intentionally omitted. This approach allows for direct AI-to-AI interaction, providing an opportunity for you to adjust prompts and responses to achieve the desired interaction style. Once testing and adjustments are complete, simply add your character name to the blacklist to prevent further responses from the AI to your character.
</WRAP>

{{https://i.imgur.com/bnwLoqR.png}}

==== Local LLM Support ====

  * **Configure and use a Local LLM endpoint** for AI-generated replies.
  * Supports **custom endpoint URLs and ports** for Local LLM.
  * Provides flexibility in choosing between **OpenAI and Local LLM** based on your setup and preferences.

<WRAP left tip 100%>
**Setup Local LLM**

  * Ensure your Local LLM server is running and accessible.
  * In the settings, select "Local LLM" as the AI Provider.
  * Enter the endpoint URL for your Local LLM (without the port).
  * Specify the port used by your Local LLM server.
  * Adjust other AI settings as needed, such as personality, max tokens, and reply delay.
</WRAP>

{{https://i.imgur.com/VtEgEZV.png}}

==== Discord Notifications ====

  * **Send in-game chat messages to Discord channels** via webhooks.
  * Notify **specific roles on Discord** for important messages or events.
  * Customizable **alert settings for different chat types**.
  * **Poll Discord channels** for new messages and execute corresponding commands in-game. (Requires your own Discord bot for replies)
  * When you add a channel, you can **configure it to receive any type of messages** you want, such as /tells, /party, etc. For example, you could set up a linkshell channel to receive S Rank notifications from other users.

{{https://i.imgur.com/pPt8ixZ.png}}

==== Player Targeting Detection ====

  * **Automatically detect when another player targets you**.
  * **Receive Discord notifications** if targeted.
  * Option to **stop the bot upon detection** to prevent unwanted interactions.
  * **AI-generated responses** can be sent to the player targeting you, with customizable prompts.
    The message will utilize your own personality with a built-in prompt to handle the targeting situation.
  * **Configurable notification intervals** for player targeting detection.

{{https://i.imgur.com/8OaitMt.png}}

==== GM Detection ====

  * **Detect nearby Game Masters (GMs)** and receive immediate alerts.
  * Configurable **notification intervals** and Discord role mentions.
  * **Automatically halt the bot** when a GM is detected for added security.

{{https://i.imgur.com/utfYXLQ.png}}

==== Hack Management ====

  * **Enable or disable speed hacks** for walking, flying, and mount speeds.
  * **Customize speed settings** to fit your preferences.
  * **Adjust camera zoom levels** for optimal viewing.
  * **Player detection range** to ensure safer usage of hacks.

{{https://i.imgur.com/4lf1kiV.png}}

==== Gil Tracker ====

  * **Notify on retainer sales**.
  * **Log sales** for record-keeping and analysis.
  * **Send notifications** to specific Discord channels for instant updates. These notifications are embedded for better readability.
  * Added option to **send Gil updates to Discord**, also embedded for a more detailed view.
  * Displays **Daily, Weekly, Monthly, and Yearly Gil earnings** in the UI.
  * Display how much **Gil you have on retainer, in FC, and in inventory**.

{{https://i.imgur.com/JD7MoHt.png}}

**Example Discord Notifications**

Here are examples of how the sale notifications and Gil updates appear when sent to Discord as embedded messages:

  * Sale Notification:
    {{https://i.imgur.com/h7K5D7J.png}}
  * Gil Update:
    {{https://i.imgur.com/13f8Mea.png}}

==== How to Enable Developer Mode on Discord ====

  * Open Discord and go to **User Settings** (the gear icon next to your username).
  * Scroll down to **Advanced**.
  * Toggle on **Developer Mode**.

==== How to Get and Copy a Webhook URL ====

  * Go to the Discord channel where you want to create a webhook.
  * Click on the **Edit Channel** button (the gear icon next to the channel name).
  * Select **Integrations**.
  * Click **Create Webhook**.
  * Customize the webhook if desired and click **Copy Webhook URL**.

==== How to Find a Channel ID (Optional) ====

  * Make sure Developer Mode is enabled (see above).
  * Right-click on the channel name.
  * Select **Copy ID**.

==== How to Create a Discord Bot and Get the Bot Token (Optional) ====

  * Go to the **Discord Developer Portal**.
  * Click **New Application**.
  * Name your application and click **Create**.
  * Navigate to the **Bot** tab and click **Add Bot**.
  * Click **Yes, do it!** to confirm.
  * Under the **Token** section, click **Copy** to get your bot token. Keep this token safe and do not share it.
  * Invite the bot to your server by going to the **OAuth2** tab, selecting bot under **OAuth2 URL Generator**, selecting the permissions you need, and using the generated URL to invite the bot to your server.

<WRAP left tip 100%>
**The Webhook URL is all you need to receive Discord alerts, the other options are optional.**
</WRAP>
=== Support ===
You can receive support for Cypher AI Chat on [Madaos Discord](https://discord.gg/UsGNaDq).

=== Disclaimer ===
Use of certain features, such as hacks, will increase your chances of getting banned.\
Please only use this if you don't care. The player detection function will disable the speed hacks when players are close by, however, use at your own risk.