Svi radovi

Javno objavljeno

Dojo Arena: serverski mod za V Rising

PvP arena mod za V Rising, na kome je oko šest meseci radio javni server. Iznova sam napisao kodnu bazu i napravio framework za komande, radeći unutar igre na Unity ECS-u preko IL2CPP-a. Kada se server ugasio, mod smo javno objavili da bi ga mogli koristiti i drugi serveri.

Uloga
Iznova napisao kodnu bazu, dizajnirao framework za komande
Tehnologije
C#, .NET 6, BepInEx (IL2CPP), Harmony, Unity ECS
Kontekst
Javni PvP arena server, razvijan zajedno sa još jednim developerom
Status
Javno objavljeno, za druge servere

Problem

V Rising je survival igra. Arena serveru treba suprotno: bez gubitka loota, bez gradnje baze, trenutni respawn i oprema na zahtev, tako da svaka borba počinje pod jednakim uslovima. Ništa od toga nije otvoreno za modovanje. Igra se preko IL2CPP-a kompajlira u native kod i zasniva se na Unity-jevom entity component sistemu, pa je svaka izmena značila pronaći pravi sistem u dekompajliranoj igri i zakačiti se na njega.

Framework ispod svega

// Commands are plain static methods. The attribute is the whole registration.
[Command("j", "<spell name> [mods: 132|1,3,2|13,2|?]", "Spawns a spell-enhancing jewel with the specified mods.", AdminOnly = false, Aliases = new[] { "jewel" })]
public static string JewelCommand(Player player, List<string> args) { /* ... */ }

[Command("kick", "<partOfName>", "Kick the specified player out of the server.", AdminOnly = true)]
public static string KickCommand(Player player, string fullArgText) { /* ... */ }


public class CommandAttribute : Attribute
{
    public string Name = "";
    public string Usage = "";
    public string Description = "";
    public string[] Aliases = null;
    public bool AdminOnly = true;   // admin-only unless a command opts out
    public bool Hidden = false;
    public CommandParameters Parameters = CommandParameters.Invalid;
    public MethodInfo Method;
}

// Signatures are checked once at load, so a badly declared command is
// rejected with a log entry instead of failing when a player uses it.
public static bool ValidateCommandMethod(CommandAttribute attribute)
{
    var paramList = attribute.Method.GetParameters();

    switch (paramList.Length)
    {
        case 0:
            attribute.Parameters = CommandParameters.None;
            return true;

        case 1:
            if (paramList[0].ParameterType == typeof(Player))
            {
                attribute.Parameters = CommandParameters.Player;
                return true;
            }
            return false;

        case 2:
            if (paramList[0].ParameterType != typeof(Player)) return false;
            if (paramList[1].ParameterType == typeof(List<string>))
            {
                attribute.Parameters = CommandParameters.PlayerAndArgs;
                return true;
            }
            else if (paramList[1].ParameterType == typeof(string))
            {
                attribute.Parameters = CommandParameters.PlayerAndFullArgText;
                return true;
            }
            return false;
        default:
            return false;
    }
}

[EventSubscriber(Events.Load)]
public static void RegisterCommands()
{
    if (!G.MethodsWithAttributes.ContainsKey(typeof(CommandAttribute))) return;
    foreach ((var commandMethod, var attribute) in G.MethodsWithAttributes[typeof(CommandAttribute)])
    {
        var commandAttribute = (CommandAttribute)attribute;
        commandAttribute.Method = commandMethod;
        commandAttribute.Name = commandAttribute.Name.ToLower().Replace(" ", "");
        var name = commandAttribute.Name;

        if (string.IsNullOrWhiteSpace(name)) continue;
        if (!ValidateCommandMethod(commandAttribute))
        {
            Output.LogError("Command-ValidationFailed", $"Command {name} has failed method validation and may be inappropriately defined.", $"MethodName = {commandMethod.Name}");
            continue;
        }

        if (Lookup.ContainsKey(name))
        {
            Output.LogError("Command-NameTaken", $"The command name '{name}' was already taken in lookup by a pre-existing command!",
                $"Method={commandAttribute.Method.Name}, Usage={commandAttribute.Usage}, Desc={commandAttribute.Description}");
            continue;
        }

        Lookup.Add(name, commandAttribute);
        SortedList.Add(commandAttribute);

        if (commandAttribute.Aliases != null)
        {
            foreach (var alias in commandAttribute.Aliases)
            {
                if (Lookup.ContainsKey(alias))
                {
                    Output.LogError("Command-AliasTaken", $"Command '{name}'s alternative alias '{alias}' in lookup by a pre-existing command!",
                        $"Method={commandAttribute.Method.Name}, Usage={commandAttribute.Usage}, Desc={commandAttribute.Description}");
                    continue;
                }

                Lookup.Add(alias, commandAttribute);
            }
        }
    }

    SortedList.Sort((x, y) => (x.Name.CompareTo(y.Name)));
}
Iz objavljenog koda, skraćeno na deo koji registruje komande.

Rad unutar igre koja za to nije pravljena

Ishod

Na modu je oko šest meseci radio javni arena server. Kada se server ugasio, javno smo ga objavili, da bi druge zajednice mogle da vode sopstvene arene.

Da ga pravim ponovo

Argumente komandi bih vezao za tipizirane parametre umesto da prosleđujem sirove stringove, da svaka komanda ne bi sama ponovo parsirala svoj ulaz, i dodao bih testove za parser i patcheve sistema. Update igre može neprimetno da promeni sisteme od kojih mod zavisi, a testovi su najjeftiniji način da to saznate pre igrača.