You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 27, 2025. It is now read-only.
| /vote | pocketvote.vote | Shows the MCPE.guru voting link associated with the server. |
4
+
| /vote top | pocketvote.vote | Shows the top voters the past month. |
5
+
| /pocketvote identity [identity]| pocketvote.admin | This sets your plugin’s identity to the one you provided. Get your server’s identity from the server dashboard at pocketvote.io. |
6
+
| /pocketvote secret [secret]| pocketvote.admin | This sets your plugin’s secret to the one you provided. Get your server’s secret from the server dashboard at pocketvote.io. |
7
+
| /pocketvote cmd list | pocketvote.admin | Lists the commands that will run when a player votes. |
8
+
| /pocketvote cmd add [command]| pocketvote.admin | Adds a command that is ran when a player votes. The following variables can be used in the command and will be replaced by the correct data: **%player**, **%ip** and **%site**. *Note that this command runs immediately as a player votes, regardless of whether they are online or not.*|
9
+
| /pocketvote cmd remove [id]| pocketvote.admin | Removes the specified command. Use ‘cmd list’ to find the command id. |
10
+
| /pocketvote cmdo list | pocketvote.admin | Lists the commands that will run when a player votes and is online. |
11
+
| /pocketvote cmdo add [command]| pocketvote.admin | Adds a command that is ran when a player votes and is online. The following variables can be used in the command and will be replaced by the correct data: **%player**, **%ip** and **%site**. *Note that this command runs only when the player is online! If they are not online while voting this command will not run until they log on.*|
12
+
| /pocketvote cmdo remove [id]| pocketvote.admin | Removes the specified command. Use ‘cmdo list’ to find the command id. |
13
+
| /pocketvote link [name]| pocketvote.admin | Attempts to set your MCPE.guru link to the provided name. Your link will look something like this mcpe.guru/[name]. |
The best fast, extensible and scalable voting solution for PocketMine servers.
2
3
3
-
The fully automated voting solution for PocketMine servers.
4
+
PocketVote acts as a smart-funnel for voting. You can use as many voting sites as you want and your server will never communicate with more than PocketVote's servers.
4
5
5
-
Add your server for free on https://pocketvote.io
6
-
Getting started is super easy!
6
+
Because PocketVote acts as a funnel we're also capable of turning off the stream of votes if your sever goes offline which means no votes are lost!
7
7
8
+
Are you sold yet? If not here's a short list of some of our features:
9
+
* Automated voting (no commands needed)
10
+
* Your very own https://mcpe.guru vote link that can be managed in-game
11
+
* Run **any** command when a vote is received
12
+
* Limit commands to users which certain permissions
13
+
* Choose whether to run command immediately or wait for the player to be online
14
+
* Voting statistics
15
+
* Third-party support through custom events and the PocketVote API
16
+
17
+
18
+
Start voting today!
19
+
20
+
# Table of Contents
21
+
1.[Getting started](#getting-started)
22
+
2.[Commands](COMMANDS.md)
23
+
3.[Permissions](PERMISSIONS.md)
24
+
4.[Configuration](#configuration)
25
+
5.[Developers](#todo)
26
+
6.[Support (Discord)](https://discord.gg/B4WHSSq)
27
+
7.[Plugins with PocketVote support](#third-party-plugins)
28
+
29
+
#### Getting started
8
30
1. Download the latest version of the plugin from https://poggit.pmmp.io/p/pocketvote
9
31
2. Start your server once after putting the plugin into your plugins directory
10
32
3. Sign up at https://pocketvote.io
11
33
4. Add your server
12
-
5. Click `show secrets`
34
+
5. Click settings and then `show secrets`
13
35
6. Take the information shown and enter it into your `config.yml`, place secret into secret field and identity/identifier in the identity field.
36
+
Since **PocketVote v3.0** you can also do this via the GUI that shows up when a OP logs in while both secret and identity is not set.
14
37
15
38
16
-
PocketMine Plugin Documentation
17
-
===============================
18
-
19
-
This file is continuously updated. If you feel something is missing or
| /vote | pocketvote.vote | Shows the MCPE.guru voting link associated with the server. |
28
-
| /vote top | pocketvote.vote | Shows the top voters the past month. |
29
-
| /pocketvote identity [identity]| pocketvote.admin | This sets your plugin’s identity to the one you provided. Get your server’s identity from the server dashboard at pocketvote.io. |
30
-
| /pocketvote secret [secret]| pocketvote.admin | This sets your plugin’s secret to the one you provided. Get your server’s secret from the server dashboard at pocketvote.io. |
31
-
| /pocketvote cmd list | pocketvote.admin | Lists the commands that will run when a player votes. |
32
-
| /pocketvote cmd add [command]| pocketvote.admin | Adds a command that is ran when a player votes. The following variables can be used in the command and will be replaced by the correct data: **%player**, **%ip** and **%site**. *Note that this command runs immediately as a player votes, regardless of whether they are online or not.*|
33
-
| /pocketvote cmd remove [id]| pocketvote.admin | Removes the specified command. Use ‘cmd list’ to find the command id. |
34
-
| /pocketvote cmdo list | pocketvote.admin | Lists the commands that will run when a player votes and is online. |
35
-
| /pocketvote cmdo add [command]| pocketvote.admin | Adds a command that is ran when a player votes and is online. The following variables can be used in the command and will be replaced by the correct data: **%player**, **%ip** and **%site**. *Note that this command runs only when the player is online! If they are not online while voting this command will not run until they log on.*|
36
-
| /pocketvote cmdo remove [id]| pocketvote.admin | Removes the specified command. Use ‘cmdo list’ to find the command id. |
37
-
| /pocketvote link [name]| pocketvote.admin | Attempts to set your MCPE.guru link to the provided name. Your link will look something like this mcpe.guru/[name]. |
38
-
| TODO: MCPE.guru commands! |||
39
39
40
40
Configuration
41
41
=============
@@ -47,6 +47,12 @@ Configuration
47
47
| secret | The secret given to you from [PocketVote.io](https://pocketvote.io) which is given to voting sites. |
48
48
| lock | If set to true, the commands to alter secret or identity is disabled. |
49
49
| vote-expiration | An amount of time to keep votes that have not been redeemed by a player, specified in **days**. |
50
-
| onvote.run-cmd | A list of commands that are to be ran immediately as a vote is retrieved. The following variables can be used in the commands: %player, %site, %ip. |
51
-
| onvote.online-cmd | A list of commands that are to be ran as soon as the target player is online. The following variables can be used in the commands: %player, %site, %ip. |
50
+
| onvote | A list of commands that are to be ran when a vote is retrieved. The following variables can be used in the commands: %player, %site, %ip. |
52
51
| votes | A list of votes waiting for players to log on. Please leave this alone. |
52
+
53
+
Third party plugins
54
+
===================
55
+
Made a plugin that supports PocketVote? [Let me know! Open an issue on GitHub](https://github.com/ProjectInfinity/PocketVote-PocketMine/issues/new).
56
+
57
+
*[PocketLotto](https://poggit.pmmp.io/p/PocketLotto) - A lottery plugin for PocketMine with support for PocketVote.
58
+
*[TopVoter (as of next version)](https://poggit.pmmp.io/p/topvoter) - A plugin that lists top voters using FloatingTextParticles.
0 commit comments