Skip to content

Commit

Permalink
style: pnpm run prettier:fix
Browse files Browse the repository at this point in the history
  • Loading branch information
@DuckySoLucky
DuckySoLucky committed Nov 10, 2023
1 parent 2e82ce5 commit 7305b87
Show file tree
Hide file tree
Showing 5 changed files with 2,123 additions and 1,465 deletions.
59 changes: 31 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ The `bot` section contains configuration options for the minecraft bot, includin
The prefix option determines the command prefix used for minecraft commands. By default, this is set to `!`.

The messageFormat option is a format for the chat message on the minecraft side, this can be customized to whatever you want, default format is `{username} » {message}`, some of the popular formats are `{username} > {message}` and `{username}: {message}`.

> Possible options for this are `{username}` and `{message}`.
The messageRepeatBypassLength option is an integer value that determines the length of a string that will be sent after message in case `You cannot say the same message twice!` occurs.
Expand Down Expand Up @@ -251,6 +252,7 @@ The `messageMode` can either be `bot`, `webhook` or `minecraft`. This selects ho
> Note - The Discord rate limit for webhooks is 30 requests every 60 seconds, where as for bot and minecraft messages it's 5 messages every 5 seconds. Using webhooks effectively halves the number of messages the bot can send per minute which may cause issues in an active guild.
The messageFormat option is a format for the chat message on the discord side, this can be customized to whatever you want, default format is `{chatType} > {skin} {rank} {username} {guildRank}§f: {message}`.

> Possible options for this are `{chatType}`, `{skin}`, `{rank}`, `{username}`, `{guildRank}` and `{message}`. They're self explanation but here's in case you don't know what they are:
>
> - `{chatType}` - Type of chat message, the only possible cases are `Guild` and `Officer`
Expand Down Expand Up @@ -284,44 +286,45 @@ The joinMessage is ability to toggle join and leave message being sent to the di
| execute | Executes commands as the minecraft bot. | `/execute [command]` | `/execute /g unmute DuckySoSkilled` | ![](https://imgur.com/fBi2Bv2.png) |
| ping | Shows the latency of the bot. | `/ping` | `/ping` | ![](https://imgur.com/9sHFgGT.png) |
| promote | Promotes the specified user by 1 rank. | `/promote [player]` | `/promote DuckySoSkilled` | ![](https://imgur.com/wmMWP5b.png) |
| restart | Restarts the bot. | `/restart` | `/restart | ![](https://imgur.com/Zn1xnBc.png) |
| restart | Restarts the bot. | `/restart` | `/restart | ![](https://imgur.com/Zn1xnBc.png) |
| unmute | Unmutes the given user. | `/unmute [player]` | `/unmute DuckySoSkilled` | ![](https://imgur.com/nlu8lo6.png) |
| uptime | Shows the uptime of the bot. | `/uptime` | `/uptime` | ![](https://imgur.com/R1cnJfn.png) |

`Minecraft`

| Command | Description | Syntax | Example | Response |
| ----------- | ------------------------------------------- | ------------------------- | -------------------------- | --------- |
| 8ball | Ask an 8ball a question. | `!8ball <question>` | `!8ball Is this bot good?` | `Yes definitely.`|
| accessories | Accessories of specified user. | `!accessories [player]` | `!accessories Refraction` | `Refraction's Accessories » 98 Recombobulated » 97 Enriched » 43` & `Refraction's Accessories » Common - 0 Uncommon - 16 Rare - 13 Epic - 26 Legendary - 16 Special - 0 Very Special - 2` |
| armor | Renders armor of specified user. | `!armor [player]` | `!armor DeathStreeks` | `DeathStreeks's armor » https://i.imgur.com/JdijFmo.png https://i.imgur.com/8uBpRrY.png https://i.imgur.com/oVQl6WV.png https://i.imgur.com/x7wlfnk.png` |
| auction | Active Auctions of specified user. | `!auction [player]` | `!auction DuckySoSkilled` | `DuckySoSkilled's Active Auctions » https://i.imgur.com/9Jw8zCK.png` |
| bedwars | BedWars stats of specified user. | `!bedwars [player]` | `!bedwars Refraction` | `[13✫] Refraction FK: 358 FKDR: 7.31 Wins: 83 WLR: 1.54 BB: 216 BLR: 3.09 WS: 3` |
| catacombs | Skyblock Dungeons Stats of specified user. | `!catacombs [player]` | `!catacombs DeathStreeks` | `DeathStreeks's Catacombs: 62.29 Class Average: 50 Secrets Found: 279,088 (8.50 SPR) Classes: H - 50 M - 50 B - 50 A - 50 T - 50` |
| duels | Duel stats of specified user. | `!duels [player]` | `!duels DuckySoSkilled` | `[Duels] [Godlike II] DuckySoSkilled Wins: 27044 CWS: 6 BWS: 536 WLR: 4.95` |
| equipment | Renders equipment of specified user. | `!equipment [name]` | `!equipment Refraction` | `Refraction's Equipment » https://i.imgur.com/QOU2r0O.png https://i.imgur.com/dUrotYa.png https://i.imgur.com/0Fxnkjd.png https://i.imgur.com/wIEcrZX.png` |
| fairysouls | Fairy Souls of specified user. | `!fairysouls [player]` | `!fairysouls DeathStreeks` | `DeathStreeks's Fairy Souls: 238/238 Progress: 100.00%` |
| fetchur | Information about an item for Fetchur. | `!fetchur [item]` | `!fetchur` | `Fetchur Requests » 1x Superboom TNT Description: This item can be purchased from the Auction House or found in dungeons` |
| guildexp | Guilds experience of specified user. | `!guildexp [player]` | `!guildexp DuckySoSkilled` | `Your Weekly Guild Experience » 1,495` |
| help | Shows help menu. | `!help` | `!help` | `https://imgur.com/BQBQXwN.png` |
| kitty | Random image of cute cat. | `!kitty` | `!kitty` | `https://i.imgur.com/jgUI7KO.jpg` |
| level | Skyblock Level of specified user. | `level [player]` | `!level DeathStreeks` | `DeathStreek's Skyblock Level » 354.59` |
| math | Calculate any kind of math problem. | `!math <calculation>` | `!math 6 * 9 + 6 + 9` | `6*9+6+9 = 69` |
| monthly | Get monthly stats of specified user. | `!monthly [player]` | `!monthly DuckySoSkilled` | `DuckySoSkilled has gained 0 karma and gained 0.1 levels in the last month.` |
| networth | Networth of specified user. | `!networth [player]` | `!networth Refraction` | `Refraction's Networth is 114 B Unsoulbound Networth: 61.9 B Purse: 3.56 B Bank: 1.07 B` |
| pet | Renders active pet of specified user. | `!pet [player]` | `!pet Refraction` | `Refraction's Active Pet » https://i.imgur.com/FVuLQk4.png` |
| render | Renders item of specified user. | `!render [player] [slot]` | `!render DuckySoSkilled` | `DuckySoSkilled's item at slot 1 » https://i.imgur.com/U2dIcSc.png` |
| skills | Skills and Skill Average of specified user. | `!skills [player]` | `!skills DuckySoSkilled` | `Skill Average » 54.44 Farming - 60.00 Mining - 60.00 Combat - 60.00 Enchanting - 60.00 Fishing - 50.00 Foraging - 50.00 Alchemy - 50.00 Taming - 50.00 Carpentry - 50.00` |
| skywars | Skywars stats of specified user. | `!skywars [player]` | `!skywars DuckySoSkilled` | `[38✫] Refraction KDR: 6.04 WLR: 1.01 WS: 0` |
| skyblock | Skyblock Stats of specified user. | `!skyblock [player]` | `!skyblock DeathStreeks` | `DeathStreeks's Level » 354.59 Senither Weight » 44,455 Lily Weight » 39,268 Skill Average » 54.4 Slayer » 7,918,100 Catacombs » 62 Class Average » 50 Networth » 133 B Accessories » 98 Recombobulated » 97 Enriched » 44` |
| ----------- | ------------------------------------------- | ------------------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 8ball | Ask an 8ball a question. | `!8ball <question>` | `!8ball Is this bot good?` | `Yes definitely.` |
| accessories | Accessories of specified user. | `!accessories [player]` | `!accessories Refraction` | `Refraction's Accessories » 98 Recombobulated » 97 Enriched » 43` & `Refraction's Accessories » Common - 0 Uncommon - 16 Rare - 13 Epic - 26 Legendary - 16 Special - 0 Very Special - 2` |
| armor | Renders armor of specified user. | `!armor [player]` | `!armor DeathStreeks` | `DeathStreeks's armor » https://i.imgur.com/JdijFmo.png https://i.imgur.com/8uBpRrY.png https://i.imgur.com/oVQl6WV.png https://i.imgur.com/x7wlfnk.png` |
| auction | Active Auctions of specified user. | `!auction [player]` | `!auction DuckySoSkilled` | `DuckySoSkilled's Active Auctions » https://i.imgur.com/9Jw8zCK.png` |
| bedwars | BedWars stats of specified user. | `!bedwars [player]` | `!bedwars Refraction` | `[13✫] Refraction FK: 358 FKDR: 7.31 Wins: 83 WLR: 1.54 BB: 216 BLR: 3.09 WS: 3` |
| catacombs | Skyblock Dungeons Stats of specified user. | `!catacombs [player]` | `!catacombs DeathStreeks` | `DeathStreeks's Catacombs: 62.29 Class Average: 50 Secrets Found: 279,088 (8.50 SPR) Classes: H - 50 M - 50 B - 50 A - 50 T - 50` |
| duels | Duel stats of specified user. | `!duels [player]` | `!duels DuckySoSkilled` | `[Duels] [Godlike II] DuckySoSkilled Wins: 27044 CWS: 6 BWS: 536 WLR: 4.95` |
| equipment | Renders equipment of specified user. | `!equipment [name]` | `!equipment Refraction` | `Refraction's Equipment » https://i.imgur.com/QOU2r0O.png https://i.imgur.com/dUrotYa.png https://i.imgur.com/0Fxnkjd.png https://i.imgur.com/wIEcrZX.png` |
| fairysouls | Fairy Souls of specified user. | `!fairysouls [player]` | `!fairysouls DeathStreeks` | `DeathStreeks's Fairy Souls: 238/238 Progress: 100.00%` |
| fetchur | Information about an item for Fetchur. | `!fetchur [item]` | `!fetchur` | `Fetchur Requests » 1x Superboom TNT Description: This item can be purchased from the Auction House or found in dungeons` |
| guildexp | Guilds experience of specified user. | `!guildexp [player]` | `!guildexp DuckySoSkilled` | `Your Weekly Guild Experience » 1,495` |
| help | Shows help menu. | `!help` | `!help` | `https://imgur.com/BQBQXwN.png` |
| kitty | Random image of cute cat. | `!kitty` | `!kitty` | `https://i.imgur.com/jgUI7KO.jpg` |
| level | Skyblock Level of specified user. | `level [player]` | `!level DeathStreeks` | `DeathStreek's Skyblock Level » 354.59` |
| math | Calculate any kind of math problem. | `!math <calculation>` | `!math 6 * 9 + 6 + 9` | `6*9+6+9 = 69` |
| monthly | Get monthly stats of specified user. | `!monthly [player]` | `!monthly DuckySoSkilled` | `DuckySoSkilled has gained 0 karma and gained 0.1 levels in the last month.` |
| networth | Networth of specified user. | `!networth [player]` | `!networth Refraction` | `Refraction's Networth is 114 B Unsoulbound Networth: 61.9 B Purse: 3.56 B Bank: 1.07 B` |
| pet | Renders active pet of specified user. | `!pet [player]` | `!pet Refraction` | `Refraction's Active Pet » https://i.imgur.com/FVuLQk4.png` |
| render | Renders item of specified user. | `!render [player] [slot]` | `!render DuckySoSkilled` | `DuckySoSkilled's item at slot 1 » https://i.imgur.com/U2dIcSc.png` |
| skills | Skills and Skill Average of specified user. | `!skills [player]` | `!skills DuckySoSkilled` | `Skill Average » 54.44 Farming - 60.00 Mining - 60.00 Combat - 60.00 Enchanting - 60.00 Fishing - 50.00 Foraging - 50.00 Alchemy - 50.00 Taming - 50.00 Carpentry - 50.00` |
| skywars | Skywars stats of specified user. | `!skywars [player]` | `!skywars DuckySoSkilled` | `[38✫] Refraction KDR: 6.04 WLR: 1.01 WS: 0` |
| skyblock | Skyblock Stats of specified user. | `!skyblock [player]` | `!skyblock DeathStreeks` | `DeathStreeks's Level » 354.59 Senither Weight » 44,455 Lily Weight » 39,268 Skill Average » 54.4 Slayer » 7,918,100 Catacombs » 62 Class Average » 50 Networth » 133 B Accessories » 98 Recombobulated » 97 Enriched » 44` |
| slayer | Slayer of specified user. | `!slayer [player] [type]` | `!slayer DeathStreeks` | `DeathStreeks's Slayer - Zombie: Level: 9 Experience: 3,165,000 Spider: Level: 9 Experience: 1,000,625 Wolf: Level: 9 Experience: 1,002,000 Enderman: Level: 9 Experience: 1,715,475 Blaze: Level: 9 Experience: 1,035,000` |
| UHC | UHC Stats of specified user. | `!UHC [player]` | `!UHC DuckySoSkilled` | `[6✫] Refraction KDR: 2.54 WLR: 69 Heads: 578` |
| weight | Skyblock Stats of specified user. | `!weight [player]` | `!weight DuckySoSkilled` | `Refraction's Senither Weight » 27721.82 Skills: 12991.95 Dungeons: 11353.90` & `Refraction's Lily Weight » 28342.24 Skills » 12310.84 Slayer » 4476.85 Dungeons » 11554.55` |
| woolwars | WoolWars stats of specified user. | `!woolwars [player]` | `!woolwars DuckySoSkilled` | `[2✫] DuckySoSkilled » W: 5 WLR: 0.5 KDR: 1.19 BB: 37 WP: 45` |
| UHC | UHC Stats of specified user. | `!UHC [player]` | `!UHC DuckySoSkilled` | `[6✫] Refraction KDR: 2.54 WLR: 69 Heads: 578` |
| weight | Skyblock Stats of specified user. | `!weight [player]` | `!weight DuckySoSkilled` | `Refraction's Senither Weight » 27721.82 Skills: 12991.95 Dungeons: 11353.90` & `Refraction's Lily Weight » 28342.24 Skills » 12310.84 Slayer » 4476.85 Dungeons » 11554.55` |
| woolwars | WoolWars stats of specified user. | `!woolwars [player]` | `!woolwars DuckySoSkilled` | `[2✫] DuckySoSkilled » W: 5 WLR: 0.5 KDR: 1.19 BB: 37 WP: 45` |

### Soopy V2 Commands

Bot also supports Soopy V2 commands, prefix is same as mod's prefix.

> ![image](https://github.com/DuckySoLucky/hypixel-discord-chat-bridge/assets/75372052/7de05d26-6b2d-4c42-b5d1-1ef0da7edafa)
### Chat Triggers Module
Expand All @@ -335,8 +338,8 @@ If you think that message format is boring, you can check out my repository for
The bot also includes event notifier that can be used to send message in guild 30 & 5 minutes before the event starts, by the default all of the events are toggled on. Feel free to disable events which you do not like in config.

Preview
> ![image](https://github.com/DuckySoLucky/hypixel-discord-chat-bridge/assets/75372052/0fc99431-3213-40fa-949b-6acca62ef63c)

> ![image](https://github.com/DuckySoLucky/hypixel-discord-chat-bridge/assets/75372052/0fc99431-3213-40fa-949b-6acca62ef63c)
### To-Do List

Expand Down
Loading

0 comments on commit 7305b87

Please sign in to comment.