Skip to content

Commit

Permalink
new readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sisby-folk committed Jul 13, 2024
1 parent 73142b4 commit a31797b
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
<!--suppress HtmlDeprecatedTag, XmlDeprecatedElement -->
<center><img alt="mod preview" src="https://cdn.modrinth.com/data/6d6uwdZy/images/48fa24a5a6dd7ca739595827445a951d54d98f8b.png" /></center>

<center>
In-game category voting for mods!<br/>
Intended for use in <a href="https://modfest.net">ModFest</a> events.
</center>

---

**BallotBox** is an in-game voting utility for ModFest events.<br/>
Players can run the `/vote` command to open a GUI that allows them to select items to vote for across multiple categories.
**BallotBox** is an in-game mod voting utility designed for ModFest events.<br/>

Players can vote for options (usually mods) across multiple award categories using a hotkey (`'`), from the pause menu, or by running `/vote`.

Items and voting categories are sent by the server, which fetches them from a REST API.<br/>
Categories and items can both contain descriptions, and items can contain URLs for the player to visit.<br/>
On close, selections are sent to the server, which securely updates them to the API using the player UUID.
**Features:**
- Server-driven voting UI - the server sends voting options, categories, and any previous vote selections.
- Data-driven vote categories.
- API-driven vote options intended for the ModFest platform API.
- Selections saved to persistent world state.
- Use `/votes` (op 4) to tally the top options for each category.

---

---
This mod was first revealed at ModFest: Carnival!<br/>
Nifty, right?

0 comments on commit a31797b

Please sign in to comment.