This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
ai_chat [2024/06/07 11:00] – 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. | + | * Supports multiple chat types, including |
- | + | * **Blacklist specific players** to prevent AI responses to their messages. | |
- | * 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. | |
- | * Adjustable reply delays to ensure natural conversation pacing. | + | * 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%> | <WRAP left tip 100%> | ||
Line 26: | Line 26: | ||
</ | </ | ||
- | {{https:// | + | {{https:// |
- | ==== Discord Notifications | + | ==== Local LLM Support |
- | * Send in-game chat messages to Discord channels via webhooks. | + | |
- | * Notify specific roles on Discord | + | * **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. | ||
- | * Customizable alert settings for different chat types. | + | <WRAP left tip 100%> |
+ | **Setup Local LLM** | ||
- | * Poll Discord channels for new messages | + | |
+ | * 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 | ||
- | * 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. | + | * **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) | ||
+ | | ||
{{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 ==== | ==== How to Enable Developer Mode on Discord ==== | ||
- | Open Discord and go to User Settings (the gear icon next to your username). | + | * 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 ==== | ==== How to Get and Copy a Webhook URL ==== | ||
- | Go to the Discord channel where you want to create a webhook. | + | * 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 ==== | + | |
+ | ==== How to Find a Channel ID (Optional) | ||
+ | |||
+ | * Make sure Developer Mode is enabled (see above). | ||
+ | * Right-click on the channel name. | ||
+ | * Select **Copy ID**. | ||
- | 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) ==== | ==== How to Create a Discord Bot and Get the Bot Token (Optional) ==== | ||
- | Go to the Discord Developer Portal. | + | * 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.** | ||
+ | </ | ||
=== 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. | ||