Complete rules system

Author: bilektugrul

pom.xml

@@ -124,5 +124,11 @@
             <version>1.0.6</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>xyz.upperlevel.spigot.book</groupId>
+            <artifactId>spigot-book-api</artifactId>
+            <version>1.4.2</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

src/main/java/io/github/bilektugrul/simpleservertools/SST.java

@@ -21,6 +21,7 @@
 import io.github.bilektugrul.simpleservertools.features.maintenance.MaintenanceManager;
 import io.github.bilektugrul.simpleservertools.features.placeholders.CustomPlaceholderManager;
 import io.github.bilektugrul.simpleservertools.features.placeholders.PAPIPlaceholders;
+import io.github.bilektugrul.simpleservertools.features.rules.RulesManager;
 import io.github.bilektugrul.simpleservertools.features.spawn.SpawnManager;
 import io.github.bilektugrul.simpleservertools.features.spy.SpyManager;
 import io.github.bilektugrul.simpleservertools.features.tpa.TPAManager;
@@ -63,6 +64,7 @@ public class SST extends JavaPlugin {
     private MaintenanceManager maintenanceManager;
     private SpyManager spyManager;
     private ConverterManager converterManager;
+    private RulesManager rulesManager;
 
     private AsyncUserSaveThread asyncUserSaveThread;
 
@@ -126,6 +128,7 @@ private void registerManagers() {
         joinMessageManager = new JoinMessageManager(this);
         tpaManager = new TPAManager(this);
         maintenanceManager = new MaintenanceManager(this);
+        rulesManager = new RulesManager(this);
 
         vanishManager = new VanishManager();
         spyManager = new SpyManager();
@@ -181,6 +184,7 @@ private void registerCommands() {
         registerCommand(new MaintenanceCommand(this), "maintenance");
         registerCommand(new SocialSpyCommand(this), "spy");
         registerCommand(new ConvertCommand(this), "convert");
+        registerCommand(new RulesCommand(this), "rules");
         registerCommand(new AFKCommand(this), "afk");
 
         if (!disabledCommands.isEmpty()) {
@@ -300,6 +304,10 @@ public boolean isConverterManagerReady() {
         return converterManager != null;
     }
 
+    public RulesManager getRulesManager() {
+        return rulesManager;
+    }
+
     public void checkAndLoadPacketListener() {
         if (pluginManager.isPluginEnabled("ProtocolLib")) {
             PLibManager.loadPacketListener(this);
@@ -326,6 +334,7 @@ public void reload(boolean first) {
             joinMessageManager.reload();
             tpaManager.loadSettings();
             maintenanceManager.reload();
+            rulesManager.reloadRules();
             if (Utils.getBoolean("auto-save-users")) {
                 asyncUserSaveThread = new AsyncUserSaveThread(this);
             } else if (asyncUserSaveThread != null) {

src/main/java/io/github/bilektugrul/simpleservertools/commands/RulesCommand.java

@@ -0,0 +1,28 @@
+package io.github.bilektugrul.simpleservertools.commands;
+
+import io.github.bilektugrul.simpleservertools.SST;
+import io.github.bilektugrul.simpleservertools.features.rules.RulesManager;
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandExecutor;
+import org.bukkit.command.CommandSender;
+import org.jetbrains.annotations.NotNull;
+
+public class RulesCommand implements CommandExecutor {
+
+    private final RulesManager rulesManager;
+
+    public RulesCommand(SST plugin) {
+        this.rulesManager = plugin.getRulesManager();
+    }
+
+    @Override
+    public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) {
+        int page = 1;
+        try {
+            page = Integer.parseInt(args[0]);
+        } catch (Exception ignored) {}
+        rulesManager.sendRules(sender, page);
+        return true;
+    }
+
+}

src/main/java/io/github/bilektugrul/simpleservertools/features/rules/RulesManager.java

@@ -0,0 +1,103 @@
+package io.github.bilektugrul.simpleservertools.features.rules;
+
+import io.github.bilektugrul.simpleservertools.SST;
+import io.github.bilektugrul.simpleservertools.utils.Utils;
+import me.despical.commons.configuration.ConfigUtils;
+import net.md_5.bungee.api.chat.*;
+import org.bukkit.command.CommandSender;
+import org.bukkit.configuration.file.FileConfiguration;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+import xyz.upperlevel.spigot.book.BookUtil;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+
+public class RulesManager {
+
+    public final SST plugin;
+    public FileConfiguration file;
+
+    public int splitRulesEvery;
+    double pageCount;
+    public List<String> rules;
+    public RuleMode ruleMode;
+
+    public RulesManager(SST plugin) {
+        this.plugin = plugin;
+        reloadRules();
+    }
+
+    public void reloadRules() {
+        file = ConfigUtils.getConfig(plugin, "rules");
+        rules = file.getStringList("lines");
+        splitRulesEvery = file.getInt("split-rules-every");
+        pageCount = (double) rules.size() / splitRulesEvery;
+        pageCount = Math.ceil(pageCount);
+        ruleMode = RuleMode.valueOf(file.getString("mode").toUpperCase(Locale.ROOT));
+    }
+
+    public List<List<String>> setupRulePages(CommandSender sender) {
+        List<List<String>> pages =  new ArrayList<>();
+        for (int i = 1; i <= pageCount; i++) {
+            pages.add(getRulesPage(i));
+        }
+        return pages;
+    }
+
+    public String pageToString(List<String> list) {
+        StringBuilder builder = new StringBuilder();
+        for (String s : list) {
+            builder.append(s).append('\n');
+        }
+        return builder.toString();
+    }
+
+    public <T> List<T> page(List<T> list, int page, int length) {
+        int size = list.size();
+        return list.subList(Math.min((page - 1) * length, size), Math.min(page * length, size));
+    }
+
+    public List<String> getRulesPage(int page) {
+        page = Math.max(1, page);
+        return page(rules, page, splitRulesEvery);
+    }
+
+    public void sendRules(CommandSender sender, int page) {
+        if (rules.isEmpty()) {
+            sender.sendMessage(Utils.getString(file, "no-rule", sender));
+            return;
+        }
+
+        if (ruleMode == RuleMode.BOOK && sender instanceof Player) {
+            openRuleBook((Player) sender);
+        } else {
+            sender.sendMessage(Utils.getString(file, "prefix", sender));
+            for (String s : getRulesPage(page)) {
+                sender.sendMessage(Utils.replacePlaceholders(s, sender, true));
+            }
+            sender.sendMessage(Utils.getString(file, "suffix", sender));
+        }
+    }
+
+    public void openRuleBook(Player player) {
+        List<List<String>> pages = setupRulePages(player);
+        List<BaseComponent[]> pageComponents = new ArrayList<>();
+        for (List<String> page : pages) {
+            String pageString = Utils.replacePlaceholders(pageToString(page), player, true);
+            pageComponents.add(new BaseComponent[]{new TextComponent(pageString)});
+        }
+        ItemStack book = BookUtil.writtenBook()
+                .pages(pageComponents)
+                .build();
+        BookUtil.openPlayer(player, book);
+    }
+
+    public enum RuleMode {
+
+        BOOK, CHAT
+
+    }
+
+}

src/main/resources/plugin.yml

@@ -102,6 +102,8 @@ commands:
   tphere:
     usage: /tphere <player>
     aliases: [s]
+  rules:
+    usage: /rules
   afk:
     usage: /afk
 

src/main/resources/rules.yml

@@ -0,0 +1,13 @@
+no-rule: '%prefix% &cThere is no rule. ANARCHY!'
+split-rules-every: 2 # splits rules to pages by every given line
+prefix: '&b&b&b&b&m---&r         &1Rules        &b&m---&r'
+suffix: '&b&b&b&b&m---&r         &1Rules        &b&m---&r'
+mode: BOOK # Modes: BOOK, CHAT
+#page-selector-in-chat: true - not implemented yet
+lines:
+    - '&cDo not use any kind of hacks.'
+    - '&cDo not swear.'
+    - '&cDo not use exploits to get better items or money.'
+    - '&cDo not steal from others.'
+    - '&cDo not attempt to scam.'
+    - '&cDo not attempt to advertise your server or any kind of website/page.'