Skip to content

Commit

Permalink
refactor: remove rank emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
jejebecarte committed Mar 2, 2024
1 parent 9cdd43e commit e5046a9
Show file tree
Hide file tree
Showing 52 changed files with 76 additions and 450 deletions.
1 change: 0 additions & 1 deletion .env.template
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ REMINDER_FREQUENCY=60
DISCORD_TOKEN=xxxxxxxxxxxxxxxxx
DISCORD_PREFIX=)
DISCORD_INVITE_LINK=discord.gg/
USE_RANK_EMOJIS=false

MEMBER_CHANNEL_ID=xxxxxxxxxxxxxxxxx
OFFICER_CHANNEL_ID=xxxxxxxxxxxxxxxxx
Expand Down
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,7 @@ history/
.env.test

# Blacklist and emojis file
src/util/_blacklist.json
src/util/emojis/_emojiIds.json
src/util/blacklist/_blacklist.json

# parcel-bundler cache (https://parceljs.org/)
.cache
Expand Down Expand Up @@ -122,6 +121,5 @@ dist
.yarn/install-state.gz
.pnp.*


#MacOSX SHIT
.DS_Store
15 changes: 0 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Rank Emojis](#rank-emojis)
- [Process Management](#process-management)
- [Contributing](#contributing)
- [Issues and Bug Reports](#issues-and-bug-reports)
Expand All @@ -38,7 +37,6 @@
- Bridges between Discord and Hypixel guild chats.
- Sends all guild related messages, including chat, guild announcements and more to Discord.
- Automatic restarts and reconnections.
- Toggleable use of Discord emojis for Hypixel ranks in chat messages.
- Privileged slash commands to control bot behaviour in-game.
- Toggleable slowmode to control member usage.
- Basic filtering of extreme profanity to protect bot accounts from abuse.
Expand Down Expand Up @@ -97,19 +95,6 @@ $ pnpm run build
$ pnpm start
```

### Rank Emojis

Optionally, you may activate the use of rank emojis in discord messages by following these steps:

1. Run the `/emojis upload` command in a discord server of your choice.

> **Note**
> It is recommended to run this command in an alternate server, as it uses a significant number of emoji slots. In this case, the user of id `BOT_OWNER_ID` is the only person with permission to run this command.
2. Set the value of `USE_RANK_EMOJIS` in the `.env` file to `true`, or `false` to disable this feature.

If at any time you wish to delete the emojis created by the bot, run the `/emojis remove` command.

### Process Management

If you are self-hosting or your process manager does not automatically restart the bot in the event of a crash, you may use [PM2](https://pm2.keymetrics.io/), a process manager for Node.js applications.
Expand Down
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"license": "MIT",
"private": false,
"scripts": {
"build": "tsc && pnpm copy-files",
"build": "tsc",
"clean": "rm -r dist/",
"copy-files": "copyfiles -u 1 src/**/*.png dist/",
"dev": "ts-node-dev --respawn --transpile-only --poll src/index.ts",
"lint:fix": "pnpm lint --fix",
"lint": "eslint . --ext .ts,.tsx",
Expand All @@ -22,7 +21,6 @@
},
"dependencies": {
"consola": "^2.15.3",
"copyfiles": "^2.4.1",
"discord.js": "14.10.2",
"dotenv": "^16.0.3",
"mineflayer": "^4.4.0",
Expand Down
Loading

0 comments on commit e5046a9

Please sign in to comment.