Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelwhiz authored Aug 5, 2024
1 parent 046f6af commit b9d6a59
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
[![Issues](https://img.shields.io/github/issues/pixelwhiz/GoKart)](https://github.com/pixelwhiz/GoKart/issues)
[![License](https://img.shields.io/github/license/pixelwhiz/GoKart)](https://github.com/pixelwhiz/GoKart/blob/master/LICENSE)

# GoKart Plugin
# 🏎️ GoKart Plugin

GoKart is a Minecraft plugin that allows players to ride and control custom minecarts with energy management and refueling mechanics. It integrates with the EconomyAPI for handling in-game currency transactions when refilling the minecart's energy.

# Features
# 🎉 Features

- Ride and control minecarts.
- Manage minecart energy levels.
- Refuel minecarts at gas stations using in-game currency.
- Handle minecart behavior with realistic physics, including jumping and movement adjustments.

# Installation
# ⚙️ Installation

1. **Download the Plugin:**
- Download the latest release from the [releases page](#).
Expand All @@ -26,24 +26,24 @@ GoKart is a Minecraft plugin that allows players to ride and control custom mine
3. **Restart the Server:**
- Restart your server to load the plugin.

# Configuration
# ⚙️ Configuration

The plugin does not require any additional configuration out of the box. However, you can customize certain aspects of the plugin through the provided classes in the codebase.

# Commands
# 📣 Commands

- **/gokart**
- Opens the GoKart menu where players can interact with minecarts.

# Interacting with Minecarts
# 🚴‍♂️ Interacting with Minecarts

1. **Ride a Minecart:**
- Use a Minecart item from your inventory to mount and ride it.

2. **Refuel Minecart:**
- Use the command `/gokart recharge` to recharge your minecart entity.

# API Reference
# 🗒️ API Reference

## `Controller` Class

Expand Down Expand Up @@ -81,18 +81,18 @@ The plugin does not require any additional configuration out of the box. However
- **`setEnergyNBT(Minecart $entity): CompoundTag`**
- Sets the energy NBT tag for a minecart entity.

# Contributing
# 👥 Contributing

Contributions are welcome! If you have suggestions or improvements, feel free to open an issue or submit a [Pull Request](https://github.com/pixelwhiz/GokartPro/compare) on this repository.

# Reporting Bugs
# ⚠️ Reporting Bugs

If you encounter any bugs or issues, please report them on the [Issue](https://github.com/pixelwhiz/GokartPro/issues/new). Provide a detailed description of the issue, steps to reproduce, and any relevant logs.

# License
# 🪪 License

This plugin is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

# Contact
# ✉️ Contact

For any questions or support, please contact me on [Discord](https://discordapp.com/users/591983759965028363).

0 comments on commit b9d6a59

Please sign in to comment.