Create README.md

This commit is contained in:
D.L.
2025-09-07 20:09:50 +02:00
committed by GitHub
parent 52aca7ba66
commit 067cec3a20

44
README.md Normal file
View File

@@ -0,0 +1,44 @@
# 💣 TNTChat
[![License](https://img.shields.io/github/license/deutschich/TNTChat)](LICENSE)
[![Spigot](https://img.shields.io/badge/Spigot-Plugin-orange)]()
[![Paper](https://img.shields.io/badge/Paper-Compatible-brightgreen)]()
[![Java](https://img.shields.io/badge/Java-8%2B-blue)]()
**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 servers `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).