Skip to content

Latest commit

 

History

History
71 lines (61 loc) · 3.26 KB

README.md

File metadata and controls

71 lines (61 loc) · 3.26 KB
Raw

PollMaster Plugin

Overview

The PollMaster Plugin is a versatile and easy-to-use tool for Minecraft servers, allowing administrators to create and manage polls directly in-game. With this plugin, server owners can engage their players by gathering feedback, making decisions, and encouraging participation in server activities.

Features

  • Create Polls: Users with the appropriate permissions can create polls with custom questions and options.
  • Vote: Players can vote on polls using the in-game chat or GUI interface.
  • Poll Management: Polls can be easily managed and viewed, with options for pagination and filtering of open polls.
  • Detailed Poll View: Players can view detailed information about each poll, including the number of votes for each option and their own selected answers.
  • Real-time Updates: Poll results are updated in real-time, allowing players to see the outcome as votes are cast.

Commands

/createpoll "<question>" "<anwser1>" "<answer2> ... [--multi]"

  • Description: Creates a new poll with the specified question and answers. The --multi flag allows multiple answers to be selected.
  • Permission: pollmaster.create
  • Example: /createpoll "What is your favorite color?" "Red" "Blue" "Green"

/polls [page]

  • Description: Opens the polls GUI, showing a list of all active polls. Use the optional page argument to navigate through multiple pages of polls.
  • Permission: pollmaster.view
  • Example: /polls 2

/vote <poll_id> <answer>

  • Description: Votes for the specified answer in the given poll.
  • Permission: pollmaster.vote
  • Example: /vote 1 "Red"

/endpoll <poll_id>

  • Description: Ends the specified poll and displays the final results.
  • Permission: pollmaster.end
  • Example: /endpoll 1

Installation

Prerequisites

  • Java: JDK 20 or higher is required to build and run the project.
  • Maven: Make sure Maven is installed on your system. You can download it here.

Cloning the Repository

  1. Clone the repository to your local machine.
git clone git@github.com:Shweit/PollMaster.git
cd PollMaster

Building the Project

  1. Build the project using Maven.
mvn clean install

Setting up the Minecraft Server

  1. Copy the generated JAR file to the plugins directory of your Minecraft server.
cp target/PollMaster-*.jar /path/to/your/minecraft/server/plugins
  1. Start or restart your Minecraft server.
java -Xmx1024M -Xms1024M -jar paper-1.21.jar nogui
  1. Once the server is running, the plugin will be loaded automatically. You can verify it by running:
/plugins

Future Features

  • Custom Poll Durations: Set start and end times for polls. If the player is offline when the poll ends, the results will be displayed when they log in.
  • Advanced Poll Analytics: Provide detailed statistics and insights on poll results.

Contributing

Contributions are welcome! Please read the contributing guidelines to get started.