Millida Rating icon

Millida Rating -----

Rating game servers Minecraft, this plugin allows you to quickly implement rewards



Millida Rating Plugin
A plugin for awarding voters on the Millida Rating monitoring system.

[​IMG]

Supported Versions:
  • Bukkit/Spigot/Paper 1.8 — 1.21
Features:
  • Award distribution
  • Cumulative reward system similar to battle passes
  • Support for MySQL and SQLite databases
  • Integration with DecentHolograms
  • Integration with PlaceholderAPI
Installation ⚙️
After placing the plugin in the plugins folder, you need to start and stop the server, as the plugin does not work without preliminary configuration for security purposes. For the initial launch, just configure server_id.

[!!!] If you do not want to issue rewards for votes made before the plugin installation, set rewards.enabled: false before the first launch of the plugin and simply execute the command /rating admin clearrewards after starting the server.

For convenient configuration while the server is running, there is the command /rating admin reload, but it is highly recommended to use it exclusively during testing, not during an already running server with players. You can add only holograms and gui to this command to reload only the hologram module.

There are also commands for testing plugin settings: /rating admin clear <nickname> and /rating admin vote <nickname>, which clear a player's progress and give them one fake vote, respectively.

[!!!] If something goes wrong, the plugin immediately shuts down for security reasons to prevent players from losing their rewards or receiving an undeservedly large amount. ⚠️

Permissions
  • millida.rating.command — access to the /rating command itself. By default, granted to all players. ✅
  • millida.rating.command.rewards — access to the /rewards and /rating rewards commands. By default, granted to all players. The command itself can be changed by modifying config.yml and plugin.yml. ✅
  • millida.rating.command.admin — access to the /rating admin command. By default, granted to all operators.
Integrations
DecentHolograms
If the DecentHolograms plugin is installed on the server, an additional configuration file holograms.yml appears in the server folder. By default, holograms are disabled, but they can be enabled and configured through this configuration file.

PlaceholderAPI
If the PlaceholderAPI plugin is installed on the server, the following placeholders are automatically registered:

  • millidarating_top_<day/week/month>_<1-10>

    Usage example:
    • millidarating_top_day_1 — top-1 for the day (maximum 10)
    • millidarating_top_week_2 — top-2 for the week (maximum 10)
    • millidarating_top_month_3 — top-3 for the month (maximum 10)
  • millidarating_top_<day/week/month>_<1-10>_votes

    Usage example:
    • millidarating_top_day_4_votes — number of votes for top-4 of the day (maximum 10)
    • millidarating_top_week_5_votes — number of votes for top-5 of the week (maximum 10)
    • millidarating_top_month_6_votes — number of votes for top-6 of the month (maximum 10)
API
The API already exists, but for now, it can only be connected through a local Maven repository. To do this, clone the repository and use the command gradle :api :publishToMavenLocal, after which it can be imported:

Code (Text):
<dependencies>
  <dependency>
   <groupId>ru.leonidm.millida</groupId>
   <artifactId>millida-rating-api</artifactId>
   <version>1.0.1</version>
  </dependency>
</dependencies>
Usage ⚙️
The main entry point to the API is the MillidaRatingApi class, from which you can obtain an instance of the API and access all necessary services.

There are also Bukkit events:

  • RatingVoteEvent — triggered when RatingRequester finds a new vote ️
  • OfflinePlayerAwardedEvent — triggered when a player receives a reward with the property online: false
  • PlayerAwardedEvent — triggered when a player receives a reward with the property online: true
[!!!] If you want to get information about votes, use the RatingRequester service, which stores hashed values, instead of RatingRequestService.

Плагин Millida Rating
Плагин для награждения голосующих в системе мониторинга Millida Rating.

[​IMG]

Поддерживаемые версии:
  • Bukkit/Spigot/Paper 1.8 — 1.21
Особенности:
  • Распределение наград
  • Кумулятивная система наград, аналогичная боевым пропускам
  • Поддержка баз данных MySQL и SQLite
  • Интеграция с DecentHolograms
  • Интеграция с PlaceholderAPI
Установка ⚙️
После размещения плагина в папке plugins, необходимо запустить и остановить сервер, так как плагин не работает без предварительной настройки в целях безопасности. Для начального запуска достаточно настроить server_id.

[!!!] Если вы не хотите выдавать награды за голоса, сделанные до установки плагина, установите rewards.enabled: false перед первым запуском плагина и просто выполните команду /rating admin clearrewards после запуска сервера.

Для удобной настройки во время работы сервера есть команда /rating admin reload, но крайне рекомендуется использовать её исключительно во время тестирования, а не на работающем сервере с игроками. Вы можете добавить только holograms и gui к этой команде, чтобы перезагрузить только модуль голограмм.

Также существуют команды для тестирования настроек плагина: /rating admin clear <nickname> и /rating admin vote <nickname>, которые очищают прогресс игрока и дают ему один фальшивый голос соответственно.

[!!!] Если что-то идёт не так, плагин немедленно отключается по соображениям безопасности, чтобы предотвратить потерю наград игроками или получение незаслуженно большого количества наград. ⚠️

Права доступа
  • millida.rating.command — доступ к самой команде /rating. По умолчанию предоставляется всем игрокам. ✅
  • millida.rating.command.rewards — доступ к командам /rewards и /rating rewards. По умолчанию предоставляется всем игрокам. Команду можно изменить, модифицировав config.yml и plugin.yml. ✅
  • millida.rating.command.admin — доступ к команде /rating admin. По умолчанию предоставляется всем операторам.
Интеграции
DecentHolograms
Если плагин DecentHolograms установлен на сервере, в папке сервера появляется дополнительный файл конфигурации holograms.yml. По умолчанию голограммы отключены, но их можно включить и настроить через этот файл конфигурации.

PlaceholderAPI
Если плагин PlaceholderAPI установлен на сервере, автоматически регистрируются следующие плейсхолдеры:

  • millidarating_top_<day/week/month>_<1-10>

    Пример использования:
    • millidarating_top_day_1 — топ-1 за день (максимум 10)
    • millidarating_top_week_2 — топ-2 за неделю (максимум 10)
    • millidarating_top_month_3 — топ-3 за месяц (максимум 10)
  • millidarating_top_<day/week/month>_<1-10>_votes

    Пример использования:
    • millidarating_top_day_4_votes — количество голосов для топ-4 за день (максимум 10)
    • millidarating_top_week_5_votes — количество голосов для топ-5 за неделю (максимум 10)
    • millidarating_top_month_6_votes — количество голосов для топ-6 за месяц (максимум 10)
API
API уже существует, но пока его можно подключить только через локальный Maven-репозиторий. Для этого клонируйте репозиторий и используйте команду gradle :api :publishToMavenLocal, после чего его можно импортировать:

Code (Text):
<dependencies>
  <dependency>
   <groupId>ru.leonidm.millida</groupId>
   <artifactId>millida-rating-api</artifactId>
   <version>1.0.1</version>
  </dependency>
</dependencies>
Использование ⚙️
Основная точка входа в API — это класс MillidaRatingApi, из которого можно получить экземпляр API и доступ ко всем необходимым сервисам.

Также существуют события Bukkit:

  • RatingVoteEvent — срабатывает, когда RatingRequester находит новый голос ️
  • OfflinePlayerAwardedEvent — срабатывает, когда игрок получает награду с параметром online: false
  • PlayerAwardedEvent — срабатывает, когда игрок получает награду с параметром online: true
[!!!] Если вы хотите получить информацию о голосах, используйте сервис RatingRequester, который хранит хэшированные значения, вместо RatingRequestService.
Resource Information
Author:
----------
Total Downloads: 79
First Release: Jun 17, 2024
Last Update: Jun 18, 2024
Category: ---------------
All-Time Rating:
13 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings