Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cshatto99/enchantify
A Minecraft Enchantment Assistant. Keep track of enchantments, view compatibility with gear, and calculate enchantments costs – solving your Minecraft enchanting complexities.
https://github.com/cshatto99/enchantify
discord-bot discord-js minecraft open-source typescript
Last synced: about 2 hours ago
JSON representation
A Minecraft Enchantment Assistant. Keep track of enchantments, view compatibility with gear, and calculate enchantments costs – solving your Minecraft enchanting complexities.
- Host: GitHub
- URL: https://github.com/cshatto99/enchantify
- Owner: CShatto99
- Created: 2024-01-19T08:43:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-05T05:50:57.000Z (12 months ago)
- Last Synced: 2024-11-22T16:08:22.201Z (2 months ago)
- Topics: discord-bot, discord-js, minecraft, open-source, typescript
- Language: TypeScript
- Homepage: https://discord.com/api/oauth2/authorize?client_id=1197698797048967178&permissions=2147552256&scope=bot
- Size: 209 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Enchantify Discord Bot
Enchantify: A Minecraft Enchantment Assistant. Keep track of enchantments, view compatibility with gear, and calculate enchantments costs – solving your Minecraft enchanting complexities.
**Invite Link:** https://discord.com/api/oauth2/authorize?client_id=1197698797048967178&permissions=2147552256&scope=bot
## Table of Contents
- [Commands](#commands)
- [Enchantment](#enchantment)
- [Enchantments](#enchantments)
- [Forge](#forge)
- [Invite](#invite)
- [Price](#price)
- [Register](#register)
- [Remove All](#remove-all)
- [Remove](#remove)
- [Installation](#installation)
- [Creating Issues](#creating-issues)
## Commands
### `/enchantment`
#### Description
Add or update an enchantment in your enchantment library.
#### Usage
```bash
/enchantment
```
#### Parameters
- `` - The enchantment name.
- `` - The enchantment level.
- `` - The price of the enchantment in emeralds.
- ` (optional)` - The gear types that the enchantment is compatible with, entered as a comma separated list.
#### Example
```bash
/enchantment Protection IV 35 Helmet,Chest,Legs,Boots
```
---
### `/enchantments`
#### Description
Lists all enchantments with optional parameters.
#### Usage
```bash
/enchantments
```
#### Parameters
- ` (optional)` - The gear type to filter by.
- ` (optional)` - Whether or not to organize the enchantments by gear type.
#### Example
```bash
/enchantments Helmet
```
---
### `/forge`
#### Description
Calculates the amount of emeralds, books, and anvils it costs to forge an enchanted book. Cost calculations are based on the level of the `?` parameter from your enchantment library.
#### Usage
```bash
/forge
```
#### Parameters
- `` - The enchantment name.
- `` - The enchantment level that you want to end up with.
#### Example (Modded Minecraft)
```bash
/forge Protection VIII
```
---
### `/invite`
#### Description
Sends the Enchantify Discord invite link to the Discord channel.
#### Usage
```bash
/invite
```
---
### `/price`
#### Description
Gets the price of an enchantment from your enchantment library.
#### Usage
```bash
/price
```
#### Parameters
- `` - The name of the enchantment that you want to see the price of.
#### Example
```bash
/price Protection
```
---
### `/register`
#### Description
Manually registers your server in the Enchantify database. This command will/should be executed a single time.
**Note:** This command is only required if your Discord server is not automatically added to the Enchantify database when the bot joins your server.
#### Usage
```bash
/register
```
---
### `/remove-all`
#### Description
Removes all enchantments from your enchantment library.
**Note:** This command can only be executed by server admins.
#### Usage
```bash
/remove-all
```
---
### `/remove`
#### Description
Removes a single enchantment from your enchantment libary.
#### Usage
```bash
/remove
```
#### Parameters
- `` - The name of the enchantment that you want to remove.
#### Example
```bash
/remove Protection
```
## Installation
Clone the repository:
```bash
git clone https://github.com/CShatto99/Enchantify.git
# or
gh repo clone CShatto99/Enchantify
```
Install the dependencies:
```bash
npm install
```
In the root of the project, rename `.env.example` to `.env` and fill out the empty environment variables.
Run the development server:
```bash
npm run dev
```
## Creating Issues
If you encounter any issues or have suggestions for improvement, feel free to create a new issue on this repository using [this link](https://github.com/CShatto99/Enchantify/issues/new).
When creating an issue, please provide detailed information about the problem or enhancement request, including steps to reproduce the issue if applicable. This will help in addressing and resolving the matter more efficiently.