Create README.md
This commit is contained in:
44
README.md
Normal file
44
README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# 💣 TNTChat
|
||||
|
||||
[](LICENSE)
|
||||
[]()
|
||||
[]()
|
||||
[]()
|
||||
|
||||
**TNTChat** is a lightweight Spigot/Paper plugin that notifies you whenever a player places **TNT** or a **TNT minecart**.
|
||||
Messages are shown directly in the **chat**, in the **console**, and also saved in a dedicated **log file**.
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
- Detects and logs TNT and TNT minecart placements
|
||||
- Messages appear in chat, console, and log files:
|
||||
`plugins/TntChat/logs/tnt-events-<date>.log`
|
||||
- Fully translatable via `texts.yml`
|
||||
- Zero configuration – just install and use
|
||||
|
||||
---
|
||||
|
||||
## 📥 Installation
|
||||
1. Download the latest release from [Releases](https://github.com/YOURNAME/TNTChat/releases)
|
||||
2. Drop the `.jar` into your server’s `plugins/` folder
|
||||
3. Restart your server
|
||||
4. Done! 🎉
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Translations
|
||||
Inside `plugins/TntChat/` you will find a `texts.yml` file.
|
||||
Edit it to translate TNTChat into your preferred language.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Compatibility
|
||||
- Works with **Spigot** & **Paper**
|
||||
- Tested on Minecraft **1.21 – 1.21.8**
|
||||
- No dependencies required
|
||||
|
||||
---
|
||||
|
||||
## 📜 License
|
||||
This project is **open source** under the [MIT License](LICENSE).
|
||||
Reference in New Issue
Block a user