-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2d52fff
commit ef952c7
Showing
1 changed file
with
87 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,91 @@ | ||
| <h1>Mention Plugin for Arcturus Morningstar 3.5.x</h1><p>A simple and easy-to-use plugin for mentioning users in a chat room. You can mention users using their username, all friends with @friends, everyone with @everyone, everyone awake with @here or the entire room with @room. The @ symbol can be placed anywhere in the message. The plugin also includes features such as blocking mentions, setting a mention timeout, choosing between bubble alert or whisper, and logging with a database or Discord.</p><h2>How to use</h2><p>To use the plugin, simply type <code>@username</code>, <code>@friends</code>, <code>@everyone</code>, or <code>@room</code> followed by your message.</p><h2>How to install</h2><ol><li>Download a pre-compiled version of the plugin from <a href="https://github.com/brenoepics/MentionPlugin/releases/" target="_new">here</a>.</li><li>Run the SQL script provided.</li><li>Move the <code>MentionPlugin-2.2-jar-with-dependencies.jar</code> file to your emulator's plugins folder and restart the emulator.</li><li>Set up user permissions by modifying the <code>acc_mention</code>, <code>acc_mention_everyone</code>, <code>acc_mention_friends</code>, and <code>acc_mention_room</code> fields in your database's permissions table.</li><li>Update the permissions by typing <code>:update_permissions</code> in the hotel or restarting the emulator.</li><li>Start mentioning users by using the mentioned keywords.</li></ol><h2>Configuration</h2><p>The plugin includes the following configuration options:</p><h4>Emulator Settings:</h4><table><thead><tr><th>Key</th><th>Default Value</th></tr></thead><tbody><tr><td><code>commands.cmd_mention_friends.prefix</code></td><td><code>friends</code></td></tr><tr><td><code>commands.cmd_mention.message_error.delete</code></td><td><code>true</code></td></tr><tr><td><code>commands.cmd_mention.message_success.delete</code></td><td><code>false</code></td></tr><tr><td><code>commands.cmd_mention.follow.enabled</code></td><td><code>true</code></td></tr><tr><td><code>commands.cmd_mention.message.show_username.enabled</code></td><td><code>true</code></td></tr><tr><td><code>commands.cmd_mention_everyone.follow.enabled</code></td><td><code>true</code></td></tr><tr><td><code>commands.cmd_mention_regex</code></td><td><code>@(\\w+)</code></td></tr><tr><td><code>commands.cmd_mention_max</code></td><td><code>5</code> (max users in same message)</td></tr><tr><td><code>mentionplugin.sanitize</code></td><td><code>true</code></td></tr><tr><td><code>mentionplugin.mode_user</code></td><td><code>1</code> (1 for bubble, 2 for whisper)</td></tr><tr><td><code>mentionplugin.mode_everyone</code></td><td><code>1</code> (1 for bubble, 2 for whisper)</td></tr><tr><td><code>mentionplugin.mode_friends</code></td><td><code>1</code> (1 for bubble, 2 for whisper)</td></tr><tr><td><code>mentionplugin.timeout_user</code></td><td><code>10</code></td></tr><tr><td><code>mentionplugin.timeout_everyone</code></td><td><code>5</code></td></tr><tr><td><code>mentionplugin.timeout_friends</code></td><td><code>60</code></td></tr><tr><td><code>mentionplugin.timeout_room</code></td><td><code>20</code></td></tr><tr><td><code>mentionplugin.logging_database</code></td><td><code>true</code></td></tr><tr><td><code>mentionplugin.database.log_timeout_minutes</code></td><td><code>30</code></td></tr></tbody></table><p>Permissions:</p><table><thead><tr><th>Key</th><th>Default Value</th></tr></thead><tbody><tr><td>acc_mention</td><td>1</td></tr><tr><td>acc_mention_friends</td><td>1</td></tr><tr><td>acc_mention_everyone</td><td>0</td></tr><tr><td>acc_mention_room</td><td>2</td></tr><tr><td>cmd_blockmention</td><td>1</td></tr></tbody></table><p>These permissions can be adjusted in the permissions table in your database. To do so, open your database and go to the permissions table and change the values of the mentioned keys as per your requirements.</p><p>Note: To take the changes into effect, you will have to type <code>:update_permissions</code> in your hotel or restart the emulator.</p> | ||
| BrenoEpic#9671 for any questions or concerns | ||
| # Mention Plugin for Arcturus Morningstar 3.5.x | ||
|
|
||
| > [!WARNING] | ||
| > Main branch is currently under development (4.0) and may not be stable. | ||
| A simple and easy-to-use plugin for mentioning users in a chat room. | ||
| You can mention users using their username, all friends with @friends, | ||
| everyone with @everyone, everyone awake with @here or the entire room with @room. | ||
| The @ symbol can be placed anywhere in the message. | ||
| The plugin also includes features such as blocking mentions, setting a mention timeout, | ||
| choosing between bubble alert or whisper, and logging with a database or Discord. | ||
|
|
||
| ## How to use | ||
|
|
||
| To use the plugin, | ||
| simply type `@username`, `@friends`, `@everyone`, | ||
| or `@room` | ||
| followed by your message. | ||
|
|
||
| ## How to install | ||
|
|
||
| - Download a pre-compiled version of the plugin | ||
| from <a href="https://github.com/brenoepics/MentionPlugin/releases/" target="_new">here</a>. | ||
| - Run the SQL script provided. | ||
| - Move the `MentionPlugin-3.0-jar-with-dependencies.jar` file to your emulator's plugins folder and restart the | ||
| emulator. | ||
| - Set up user permissions by modifying the `acc_mention`, | ||
| `acc_mention_everyone`, `acc_mention_friends`, and `acc_mention_room` | ||
| fields in your database's permissions table. | ||
| - Update the permissions by typing `:update_permissions` in the hotel or restarting the emulator. | ||
| - Start mentioning users by using the mentioned keywords. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The plugin includes the following configuration options: | ||
|
|
||
| ### Emulator Settings | ||
|
|
||
| | Key | Default Value | Meaning | | ||
| |------------------------------------------------------|---------------|-----------------------------| | ||
| | `commands.cmd_mention_friends.prefix` | `friends` | | | ||
| | `commands.cmd_mention.message_error.delete` | `true` | | | ||
| | `commands.cmd_mention.message_success.delete` | `false` | | | ||
| | `commands.cmd_mention.follow.enabled` | `true` | | | ||
| | `commands.cmd_mention.message.show_username.enabled` | `true` | | | ||
| | `commands.cmd_mention_everyone.follow.enabled` | `true` | | | ||
| | `commands.cmd_mention_regex` | `@(\\w+)` | | | ||
| | `commands.cmd_mention_max` | `5` | max users in same message | | ||
| | `mentionplugin.sanitize` | `true` | | | ||
| | `mentionplugin.mode_user` | `1` | 1 for bubble, 2 for whisper | | ||
| | `mentionplugin.mode_everyone` | `1` | 1 for bubble, 2 for whisper | | ||
| | `mentionplugin.mode_friends` | `1` | 1 for bubble, 2 for whisper | | ||
| | `mentionplugin.timeout_user` | `10` | | | ||
| | `mentionplugin.timeout_everyone` | `5` | | | ||
| | `mentionplugin.timeout_friends` | `60` | | | ||
| | `mentionplugin.timeout_room` | `20` | | | ||
| | `mentionplugin.logging_database` | `true` | | | ||
| | `mentionplugin.database.log_timeout_minutes` | `30` | | | ||
|
|
||
| ### Permissions | ||
|
|
||
| | Key | Default Value | | ||
| |----------------------|---------------| | ||
| | acc_mention | 1 | | ||
| | acc_mention_friends | 1 | | ||
| | acc_mention_everyone | 0 | | ||
| | acc_mention_room | 2 | | ||
| | cmd_blockmention | 1 | | ||
|
|
||
| These permissions can be adjusted in the permissions table in your database. | ||
| To do so, | ||
| open your database and go to the permissions table | ||
| and change the values of the mentioned keys as per your requirements. | ||
|
|
||
| > [!NOTE] | ||
| > To take the changes into effect, you will have to type `:update_permissions` in your hotel or restart the emulator. | ||
| ## FAQ | ||
|
|
||
| ### 1. Why am I disconnected when I get a mention in flash client? | ||
|
|
||
| ## Why am I disconnected when I get a mention in flash client? | ||
| Flash Client Error | ||
|
|
||
| Your image link is not a valid .png or .gif, and flash client disconnects when receiving the bubble alert. To resolve this issue, change the key commands.cmd_mention_everyone.look in the emulator_texts to a valid .png or .gif. | ||
| Your image link is not a valid .png or .gif, and flash client disconnects when receiving the bubble alert. | ||
| To resolve this issue, change the key commands.cmd_mention_everyone.look in the emulator_texts to a valid .png or .gif. | ||
|
|
||
| ### 2. How to report a bug or suggest a feature? | ||
|
|
||
| You can report a bug or suggest a feature by creating an issue on the GitHub repository or contacting me on Discord: | ||
| brenoepic | ||
|
|