https://github.com/dsnsgithub/minecraftchatbot

This is a Minecraft Chat Bot that allows for communication between people who speak different languages.
https://github.com/dsnsgithub/minecraftchatbot

Last synced: 5 days ago
JSON representation

This is a Minecraft Chat Bot that allows for communication between people who speak different languages.

• Host: GitHub
• URL: https://github.com/dsnsgithub/minecraftchatbot
• Owner: dsnsgithub
• License: agpl-3.0
• Created: 2024-02-17T09:37:24.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-04-13T03:07:09.000Z (7 months ago)
• Last Synced: 2024-04-14T04:09:43.003Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 214 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minecraft Chat Bot

This is a Minecraft Chat Bot that allows for communication between people who speak different languages, mainly designed for anarchy servers.

![image](https://github.com/dsnsgithub/minecraftchatbot/assets/48170013/9ae69b9c-b152-4c45-800e-745eaeeef5a2)

## Features

1. Translate Command

- **Description**: This command allows users to request translation of messages from other players using the [Translateer API](https://github.com/Songkeys/Translateer).

- **Usage**: `?translate [IGN] [optional: messagesSinceLast] [optional: language]`

   

2. Help Command

- **Description**: This command provides users with a list of available commands.

- **Usage**: `?help`

3. Coordinates Display Command

- **Description**: This command allows users to see the bot's current coordinates within the Minecraft world.

- **Usage**: `?coords`

4. KD (Kill/Death Ratio) Command

- **Description**: This command provides information about a player's kill and death counts, or the kill and death counts of a specified player.

- **Usage**: `?kd [optional: IGN]`

5. Most Kills Command

- **Description**: This command displays the top 3 players with the most kills along with their kill count.

- **Usage**: `?mostkills`

6. Most Deaths Command

- **Description**: This command displays the top 3 players with the most deaths along with their death count.

- **Usage**: `?mostdeaths`

## Components

- **Mineflayer**: A library for creating Minecraft bots in Node.js.

- **Prismarine Viewer**: Provides visualization capabilities for the Minecraft world.

- **Mineflayer Pathfinder**: Adds pathfinding functionality to the bot, allowing it to navigate through the game world.

- **Axios**: HTTP client for making requests to external APIs.

## Usage

1. Clone the repository

2. Install dependencies using `npm install`

3. Set up environment variables in a `.env` file. Required variables include:

   - `SERVER`: Minecraft server host

   - `IGN`: Bot's in-game name

   - `PREFIX`: Prefix for bot commands (e.g., `?`)

   - `PASSWORD`: Bot's login password (if applicable)

   - `WEB`: Whether to enable web visualization (`true` or `false`)

4. Create a `db` directory, place `playerDB.json` inside it.

5. Place `{}` inside the `playerDB.json` file.

5. Run the bot using `ts-node .`