Merge pull request #11 from KeyouXZ/dev

Author: KeyouXZ

Config.md

@@ -171,6 +171,14 @@ This document details the configuration settings for the shop system.
 | Default | "ShopRegion" |
 | Example | "ShopRegion", "Shop" |
 
+### List Length
+
+| Field | Value |
+|-------|--------|
+| Type | Integer |
+| Description | Number of items to display in the shop list |
+| Default | 5 |
+
 ## Shop Items
 
 ### Shop Items Configuration

README.md

@@ -189,30 +189,26 @@ This command will show a list of all items that can be bought, along with their
 **Usage**:
 `/rank down`
 
-#### `/rankutils list`
+#### `/rank list`
 
 **Description**: List all available ranks
 
-#### `/rankutils <command>`
-
-**Description**: Displays rankutils commands
-
 **Usage**:
-`/rankutils list`
+`/rank list`
 
-### `/rankutils info`
+### `/rank info`
 
 **Description**: Displays rank details
 
 **Usage**:
-`/rankutils info <rank>`
+`/rank info <rank name>`
 
-- `<rank>`: The name of the rank you want to view
+- `<rank name>`: The name of the rank you want to view
 
 **Example:**
 
 ```cmd
-/rankutils info Master
+/rank info Master
 ```
 
 This command will display the details of the rank named "Master".
@@ -271,9 +267,8 @@ Set up the following permissions to control access to the plugin features:
 | `/rank`            | `skynomi.rank`            |
 | `/rank up`         | `skynomi.rank.up`         |
 | `/rank down`       | `skynomi.rank.down`       |
-| `/rankutils`       | `skynomi.rankutils`       |
-| `/rankutils list`  | `skynomi.rankutils.list`  |
-| `/rankutils info`  | `skynomi.rankutils.info`  |
+| `/rank list`       | `skynomi.rank.list`       |
+| `/rank info`       | `skynomi.rank.info`       |
 | `/resetrank`       | `skynomi.resetrank`       |
 | `/resethighestrank`| `skynomi.resethighestrank`|
 
@@ -340,7 +335,7 @@ See [Config Document](./Config.md) for this
 - Rank System: `v1.0.0` -> `v1.1.0`
   - Added `Announce Rank Up` configuration
   - Added `Enable Rank Down` configuration
-  - Added `rankutils info` & `rankutils list` commands
+  - Added `rank info` & `rank list` commands
 
 **Version 2.1.0**
 
@@ -397,10 +392,23 @@ See [Config Document](./Config.md) for this
   - New command: `leaderboard`
 - Rank System: `v1.1.3` -> `v1.2.0`
   - New feature: Item restriction for rank system. Config: `"Restricted Items"`
-  - Corrected rankutils permission
+  - Corrected rank permission
   - New command: `resetrank` and `resethighestrank`
   - New Feature: Syncs player group with stored rank, caps rank at max if exceeded, updates cache, and notifies the player.
 
+**Version 3.2.1**
+
+- Skynomi: `v3.2.0` -> `v3.2.1`
+  - Fix possible InvalidCastException at CacheManager
+  - Introduce `Config` as replacement for `config` (deprecated)
+- Rank System: `v1.2.0` -> `v1.3.0`
+  - Renamed `rankutils` command to `rank` for clarity and consistency
+  - Restricted `rank up/down` commands to players in the `rank` group only
+  - Changed config `Cost` type from `int` to `long` to support larger values
+  - Miscellaneous logic fixes and improvements
+- Shop System: `v1.2.0` -> `v1.3.0`
+  - New feature: Controls how many items appear per page in the `/shop list` command. Config: `"List Length"`
+
 ## License
 
 This plugin is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html).

Skynomi.RankSystem/Commands.cs

@@ -17,15 +17,9 @@ public static void Initialize()
 
             // Init Commands
             TShockAPI.Commands.ChatCommands.Add(new Command(Permissions.Rank, Rank, "rank", "level")
-            {
-                AllowServer = false,
-                HelpText = "Rank commands:\nup - Rank up to the next level\ndown - Rank down to the previous level"
-            });
-
-            TShockAPI.Commands.ChatCommands.Add(new Command(Permissions.RankUtils, RankUtils, "rankutils")
             {
                 AllowServer = true,
-                HelpText = "Rank Utils commands:\ninfo <rank> - Get information about a rank\nlist - List all available ranks"
+                HelpText = "Rank commands:\nup - Rank up to the next level\ndown - Rank down to the previous level\ninfo <rank name> - Get information about a rank\nlist - List all available ranks"
             });
 
             TShockAPI.Commands.ChatCommands.Add(new Command(Permissions.ResetRank, ResetRank, "resetrank")
@@ -51,14 +45,21 @@ private static void Rank(CommandArgs args)
         {
             try
             {
-                string usage = "Usage: /rank <up/down>";
+                string usage = "Usage: /rank <up/down/info/list>";
 
                 if (args.Parameters.Count == 0)
                 {
                     args.Player.SendErrorMessage(usage);
                     return;
                 }
 
+                // Check if the player is from rank group
+                if ((args.Parameters[0] == "up" || args.Parameters[0] == "down") && !args.Player.Group.Name.StartsWith("rank_") && args.Player.Group.Name != TShock.Config.Settings.DefaultRegistrationGroupName)
+                {
+                    args.Player.SendErrorMessage("You are not in a rank group.");
+                    return;
+                }
+
                 if (args.Parameters[0] == "up")
                 {
                     if (!Utils.Util.CheckPermission(Permissions.RankUp, args)) return;
@@ -80,7 +81,7 @@ private static void Rank(CommandArgs args)
 
                         // Check user balance
                         long balance = database.GetBalance(args.Player.Name);
-                        int rankCost = rankConfig.Ranks[nextRank].Cost;
+                        long rankCost = rankConfig.Ranks[nextRank].Cost;
 
                         if (balance < rankCost)
                         {
@@ -147,7 +148,7 @@ private static void Rank(CommandArgs args)
                     {
                         string nextRank = GetRankByIndex(nextIndex);
 
-                        int rankCost = rankConfig.Ranks[GetRankByIndex(nextIndex)].Cost;
+                        long rankCost = rankConfig.Ranks[GetRankByIndex(nextIndex)].Cost;
 
                         database.AddBalance(args.Player.Name, rankCost);
                         Skynomi.Database.CacheManager.Cache.GetCache<Database.TRank>("Ranks").Modify(args.Player.Name, e =>
@@ -163,33 +164,10 @@ private static void Rank(CommandArgs args)
                         args.Player.SendErrorMessage("You are already at the lowest rank.");
                     }
                 }
-                else
-                {
-                    args.Player.SendErrorMessage(usage);
-                }
-            }
-            catch (Exception ex)
-            {
-                Utils.Log.Error(ex.ToString());
-            }
-
-        }
-
-        private static void RankUtils(CommandArgs args)
-        {
-            try
-            {
-                string usage = "Usage: /rankutils <info/list>";
-                if (args.Parameters.Count == 0)
-                {
-                    args.Player.SendErrorMessage(usage);
-                    return;
-                }
-
-                if (args.Parameters[0] == "info")
+                else if (args.Parameters[0] == "info")
                 {
                     if (!Utils.Util.CheckPermission(Permissions.RankInfo, args)) return;
-                    string infoUsage = "Usage: /rankutils info <rank>";
+                    string infoUsage = "Usage: /rank info <rank name>";
 
                     if (args.Parameters.Count < 2)
                     {
@@ -201,16 +179,42 @@ private static void RankUtils(CommandArgs args)
                     if (rankConfig.Ranks.ContainsKey(rank))
                     {
                         string rankPrefix = rankConfig.Ranks[rank].Prefix;
+                        if (string.IsNullOrEmpty(rankPrefix))
+                        {
+                            rankPrefix = "-";
+                        }
+
                         string rankSuffix = rankConfig.Ranks[rank].Suffix;
+                        if (string.IsNullOrEmpty(rankSuffix))
+                        {
+                            rankSuffix = "-";
+                        }
+
                         int[] ChatColor = rankConfig.Ranks[rank].ChatColor;
+
                         string hex = $"{ChatColor[0]:X2}{ChatColor[1]:X2}{ChatColor[2]:X2}";
+
                         string formattedColor = $"[c/{hex}:Hello]";
-                        int rankCost = rankConfig.Ranks[rank].Cost;
+
+                        long rankCost = rankConfig.Ranks[rank].Cost;
+
                         string rankPermission = rankConfig.Ranks[rank].Permission;
+                        if (string.IsNullOrEmpty(rankPermission))
+                        {
+                            rankPermission = "-";
+                        }
+
                         string rankReward = "";
-                        foreach (var item in rankConfig.Ranks[rank].Rewards)
+                        if (rankConfig.Ranks[rank].Rewards.Count == 0)
                         {
-                            rankReward += $"[i/s{item.Value}:{item.Key}] ";
+                            rankReward = "-";
+                        }
+                        else
+                        {
+                            foreach (var item in rankConfig.Ranks[rank].Rewards)
+                            {
+                                rankReward += $"[i/s{item.Value}:{item.Key}] ";
+                            }
                         }
 
                         string detail = $"[c/00FF00:=== Rank Details ===]\n" +
@@ -219,7 +223,7 @@ private static void RankUtils(CommandArgs args)
                             $"[c/0000FF:Suffix:] {rankSuffix}\n" +
                             $"[c/0000FF:Chat Color:] {formattedColor} ([c/{hex}:#{hex}])\n" +
                             $"[c/0000FF:Cost:] {Utils.Util.CurrencyFormat(rankCost)}\n" +
-                            $"[c/0000FF:Permissioon:] {rankPermission}\n" +
+                            $"[c/0000FF:Permission:] {rankPermission}\n" +
                             $"[c/0000FF:Reward:] {rankReward}";
 
                         args.Player.SendMessage(detail, Color.White);
@@ -232,15 +236,23 @@ private static void RankUtils(CommandArgs args)
                 else if (args.Parameters[0] == "list")
                 {
                     if (!Utils.Util.CheckPermission(Permissions.RankList, args)) return;
+                    if (rankConfig.Ranks.Count == 0)
+                    {
+                        args.Player.SendErrorMessage("No ranks available.");
+                        return;
+                    }
 
-                    string text = "Rank List:";
-                    args.Player.SendSuccessMessage(text);
-                    text = "";
+                    string text = "[c/00FF00:=== Rank List ===]";
+                    int counter = 1;
                     foreach (var rank in rankConfig.Ranks)
                     {
-                        text += $"\"{rank.Key}\" ";
+                        int[] ChatColor = rank.Value.ChatColor;
+                        string hex = $"{ChatColor[0]:X2}{ChatColor[1]:X2}{ChatColor[2]:X2}";
+
+                        text += $"\n{counter}. [c/{hex}:{rank.Key}]";
+                        counter++;
                     }
-                    args.Player.SendInfoMessage(text);
+                    args.Player.SendMessage(text, Color.White);
                 }
                 else
                 {
@@ -251,6 +263,7 @@ private static void RankUtils(CommandArgs args)
             {
                 Utils.Log.Error(ex.ToString());
             }
+
         }
 
         private static void ResetRank(CommandArgs args)
@@ -288,7 +301,7 @@ private static void ResetRank(CommandArgs args)
                     args.Player.SendSuccessMessage("All players rank has been reset.");
                     return;
                 }
-                
+
                 var player = TSPlayer.FindByNameOrID(who).FirstOrDefault(x => x != null && x.Name.Equals(who, StringComparison.OrdinalIgnoreCase));
                 if (player != null)
                 {

Skynomi.RankSystem/Config.cs

@@ -88,7 +88,7 @@ public class Rank
             public int[] ChatColor = Array.Empty<int>();
 
             [JsonProperty("Cost")]
-            public int Cost;
+            public long Cost;
 
             [JsonProperty("Permission")]
             public string Permission = string.Empty;

Skynomi.RankSystem/RankSystem.cs

@@ -15,7 +15,7 @@ public class Ranks : Loader.ISkynomiExtension, Loader.ISkynomiExtensionReloadabl
     {
         public string Name => "Rank System";
         public string Description => "Rank system extension for Skynomi";
-        public Version Version => new(1, 2, 0);
+        public Version Version => new(1, 3, 0);
         public string Author => "Keyou";
 
         private static Config rankConfig;
@@ -48,22 +48,22 @@ public void Reload(ReloadEventArgs args)
         private void OnPlayerJoin(GreetPlayerEventArgs args)
         {
             Database.CreatePlayer(TShock.Players[args.Who].Name);
-            var cache = CacheManager.Cache.GetCache<Database.TRank>("Ranks");
-            var ranks = rankConfig.Ranks;
-            var player = TShock.Players[args.Who];
+            CacheManager.CacheEntry<Database.TRank>? cache = CacheManager.Cache.GetCache<Database.TRank>("Ranks");
+            Dictionary<string, Config.Rank>? ranks = rankConfig.Ranks;
+            TSPlayer? player = TShock.Players[args.Who];
 
             if (player.Account == null)
                 return;
 
             if (!cache.TryGetValue(player.Name, out var plrRank)) return;
-            var playerGroup = player.Group;
-            var regex = new Regex(@"rank_(\d+)");
-            var match = regex.Match(playerGroup.Name);
+            TShockAPI.Group? playerGroup = player.Group;
+            Regex? regex = new(@"rank_(\d+)");
+            Match? match = regex.Match(playerGroup.Name);
 
             if (match.Success)
             {
                 // Set to max rank in the configuration
-                if (ranks.Count < plrRank.Rank)
+                if (plrRank.Rank - 1 > ranks.Count)
                 {
                     TShock.UserAccounts.SetUserGroup(player.Account, "rank_" + ranks.Count);
                     cache.Modify(player.Name, e =>
@@ -94,7 +94,7 @@ private void OnPlayerJoin(GreetPlayerEventArgs args)
                                     e.Rank = defaultRank;
                                     return e;
                                 });
-                                
+
                                 message = $"Your rank has been corrected to {Commands.GetRankByIndex(plrRank.Rank - 1)}.";
                             }
                             else
@@ -129,12 +129,20 @@ private static void CreateGroup(int status)
                 string name = "rank_" + counter;
                 string prefix = key.Value.Prefix;
                 string suffix = key.Value.Suffix;
-                string parent = (counter == 1) ? "default" : "rank_" + (counter - 1);
+                string parent = (counter == 1) ? TShock.Config.Settings.DefaultRegistrationGroupName : "rank_" + (counter - 1);
                 if (!rankConfig.useParent) parent = "";
 
                 int[] color = key.Value.ChatColor;
+                if (color == null || color.Length != 3)
+                {
+                    Log.Warn($"Rank '{name}' ({key.Key}) has invalid chat color. Defaulting to white.");
+                    color = new[] { 255, 255, 255 };
+                }
+                
                 string chatColor = $"{color[0]},{color[1]},{color[2]}";
-                string permission = parent == "" ? key.Value.Permission.Replace(" ", ",") : TShock.Groups.GetGroupByName(parent).Permissions + "," + key.Value.Permission.Replace(" ", ",");
+                var parentGroup = TShock.Groups.GetGroupByName(parent);
+                string parentPermissions = parentGroup != null ? parentGroup.Permissions : "";
+                string permission = parent == "" ? key.Value.Permission.Replace(" ", ",") : parentPermissions + "," + key.Value.Permission.Replace(" ", ",");
 
                 // Create the group
                 if (status == 1)

Skynomi.RankSystem/RankSystemConfig.cs

@@ -5,9 +5,8 @@ public abstract class Permissions
         public static readonly string Rank = "skynomi.rank";
         public static readonly string RankUp = "skynomi.rank.up";
         public static readonly string RankDown = "skynomi.rank.down";
-        public static readonly string RankUtils = "skynomi.rankutils";
-        public static readonly string RankList = "skynomi.rankutils.list";
-        public static readonly string RankInfo = "skynomi.rankutils.info";
+        public static readonly string RankList = "skynomi.rank.list";
+        public static readonly string RankInfo = "skynomi.rank.info";
         public static readonly string ResetRank = "skynomi.rank.resetrank";
         public static readonly string ResetHighestRank = "skynomi.rank.resethighestrank";
     }

Skynomi.RankSystem/Skynomi.RankSystem.csproj

@@ -12,10 +12,10 @@
   </PropertyGroup>
 
   <PropertyGroup>
-		<Version>1.2.0</Version>
-		<FileVersion>1.2.0.0</FileVersion>
-		<AssemblyVersion>1.2.0.0</AssemblyVersion>
-		<InformationalVersion>1.2.0</InformationalVersion>
+		<Version>1.3.0</Version>
+		<FileVersion>1.3.0.0</FileVersion>
+		<AssemblyVersion>1.3.0.0</AssemblyVersion>
+		<InformationalVersion>1.3.0</InformationalVersion>
 	</PropertyGroup>
 
   <ItemGroup>