This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
ai_chat [2024/06/03 13:01] – cypher | ai_chat [2024/06/15 19:12] (current) – cypher | ||
---|---|---|---|
Line 1: | Line 1: | ||
<WRAP center round alert 40%> | <WRAP center round alert 40%> | ||
- | This addon has NO requirements and is standalone | + | This addon has NO requirements and is standalone. |
</ | </ | ||
Line 10: | Line 10: | ||
==== AI Chat Integration ==== | ==== 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. | + | * **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. | ||
- | * Supports multiple chat types, including Say, Shout, Tell, Party, and more. | + | <WRAP left tip 100%> |
+ | **Testing AI Responses without your Character Name Blacklisted** | ||
- | * Blacklist specific players | + | 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, |
+ | </ | ||
- | * Adjustable reply delays to ensure natural conversation pacing. | + | {{https://i.imgur.com/ |
- | {{https:// | + | ==== Local LLM Support ==== |
- | ==== Discord Notifications ==== | + | * **Configure and use a Local LLM endpoint** for AI-generated replies. |
- | * Send in-game chat messages to Discord channels via webhooks. | + | * Supports **custom endpoint URLs and ports** for Local LLM. |
+ | * Provides flexibility | ||
- | * Notify specific roles on Discord for important messages or events. | + | <WRAP left tip 100%> |
+ | **Setup Local LLM** | ||
- | * Customizable alert settings for different chat types. | + | |
+ | * 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, | ||
+ | </ | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | ==== Discord Notifications ==== | ||
- | * Poll Discord channels for new messages and execute corresponding commands in-game. (Requires your own Discord bot for replies) | + | * **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:// | {{https:// | ||
==== Player Targeting Detection ==== | ==== Player Targeting Detection ==== | ||
- | * Automatically detect when another player targets you. | ||
- | * Receive Discord notifications if targeted. | + | * **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. | ||
- | * Option to stop the bot upon detection to prevent unwanted interactions. | + | {{https:// |
- | + | ||
- | {{https:// | + | |
==== GM Detection ==== | ==== GM Detection ==== | ||
- | * Detect nearby Game Masters (GMs) and receive immediate alerts. | ||
- | * Configurable notification intervals and Discord role mentions. | + | * **Detect nearby Game Masters (GMs)** and receive immediate alerts. |
- | + | | |
- | * Automatically halt the bot when a GM is detected for added security. | + | * **Automatically halt the bot** when a GM is detected for added security. |
{{https:// | {{https:// | ||
==== Hack Management ==== | ==== Hack Management ==== | ||
- | * Enable or disable speed hacks for walking, flying, and mount speeds. | ||
- | * Customize speed settings to fit your preferences. | + | * **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. | + | * **Adjust camera zoom levels** for optimal viewing. |
- | + | * **Player detection range** to ensure safer usage of hacks. | |
- | * Player detection range to ensure safer usage of hacks. | + | |
{{https:// | {{https:// | ||
==== Gil Tracker ==== | ==== Gil Tracker ==== | ||
- | * Notify on retainer sales. | ||
- | * Log sales for record-keeping and analysis. | + | * **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**. | ||
- | * Send notifications to specific Discord channels for instant updates. | + | {{https://i.imgur.com/ |
- | * Displays Daily, Weekly, Monthly, and Yearly Gil earnings in the UI. | + | **Example Discord Notifications** |
- | * Display | + | Here are examples of how the sale notifications |
- | {{https:// | + | * Sale Notification: |
+ | {{https:// | ||
+ | * Gil Update: | ||
+ | | ||
+ | ==== 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**, | ||
+ | |||
+ | <WRAP left tip 100%> | ||
+ | **The Webhook URL is all you need to receive Discord alerts, the other options are optional.** | ||
+ | </ | ||
=== Support === | === Support === | ||
You can receive support for Cypher AI Chat on [Madaos Discord](https:// | You can receive support for Cypher AI Chat on [Madaos Discord](https:// | ||
=== Disclaimer === | === Disclaimer === | ||
- | Use of certain features, such as hacks, will increase your chances of getting banned. | + | 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. | 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. | ||