Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PZStatus

Description

PZStatus is a Discord bot designed to monitor the status of your Minecraft server. It provides real-time updates on server availability, player counts, and version information.

Features

  • Real-time server status checks
  • Player count monitoring
  • Version information display
  • Customizable configuration
  • Notification through Discord embeds

Installation

  1. Clone the repository:

    git clone https://github.com/NotJunar/PZStatus.git
    cd PZStatus
  2. Install dependencies:

    npm install
  3. Configure the bot:

    • Update config.yml with your server details and Discord bot token.

Usage

  • Run the bot:

    node index.js
  • Commands:

    • !trigger-check - Manually trigger a server status check.

Configuration

Example config.yml:

ipAddress: "localhost"
port: 25565
check_interval: 60
channel_id: "YOUR_CHANNEL_ID"
token: "YOUR_BOT_TOKEN"

Contributing

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-branch
  3. Make your changes.
  4. Commit your changes:
    git commit -m "Add new feature"
  5. Push to the branch:
    git push origin feature-branch
  6. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Acknowledgements

  • discord.js - The library used to interact with Discord's API.
  • node-fetch - For making HTTP requests to the server status API.

GitHub stars GitHub forks

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages