Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added wiki and features
  • Loading branch information
NooberPro authored Apr 8, 2023
1 parent 82c9508 commit c57f418
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# minecraft-discord-bot
A discord bot that shows info and status of your minecraft server including players, version, and many more features.
# Minecraft Server Status Bot for Discord

## [DOCUMENTATION HERE 🔗](https://nooberpro.gitbook.io/mc-status-bot/)
Wiki is in Progess.

### *This Bot shows the status of a minecraft server in real time with a embed in discord and allow players to know if server is online.*

This bot code uses **PingMC npm package** for getting status of Minecraft servers
- PingMC package
- [npmjs Package](https://www.npmjs.com/package/pingmc)
- [Github Repository](https://github.com/MrZillaGold/PingMC)

### WHAT CAN THIS BOT DO?
At this moment the bot can only update the status in a embed but more features will be added in the future.

When Server is Online, Embed Deatils about your server will be different. The embed will be like this =>

![OnlineEMbed](https://i.imgur.com/HDjlmkE.png)

When server is offline. It will be like this =>

![OfflineEMbed](https://i.imgur.com/wODw8v1.png)


# TO DO LIST

- [ ] Custom reply for ip, Status, test, Player list and version command
- [ ] Bot status (activity) for players online number
- [ ] Custon reply when user ask if server is off or on

0 comments on commit c57f418

Please sign in to comment.