arcaneplugins / arcaneframework Goto Github PK

• WholeSound
• WholeTitle
• MultiMessage replacement

Once ArcaneFramework is sufficiently complete, MicroLib will be declared as a discontinued resource.

This will replace MicroLib's MultiMessage class, to achieve something very similar to LevelledMobs 4's Message enum.

• don't annotate vars with nullability. oops
• getters setters etc
• fix incorrect types. enchantments and attribute modifiers should be maps and multimaps respectively.

A baseline should be provided so projects can at least get acquainted with setting up AF for their resource (plugin.yml libraries feature, etc). Later on, the Wiki can be expanded.

TitleWrapper will be a rewrite of MicroLib's WholeTitle class which allows titles to be easily assembled, sent and stored within a plugin, everything done in a single variable rather than multiple.

AF should have a plugin lockdown system. This system is designed to make it easy for a plugin to effectively 'soft-shut-down' itself when a major issue occurs which it cannot rescue from (e.g., the administrator has mis-configured the plugin). In lockdown mode, the plugin frequently warns that it is in the mode, why, how to fix it, and what to do once a fix has been attempted (reload the plugin). Lockdown mode has a separate command system which has no configurable components to be as simple as possible. This command system offers /<plugin_base_command> reload, e.g., /lm reload, so that the server owner can try to fix the issue without having to restart their entire server. During lockdown mode, a plugin might want to have some listeners or commands still available in case it is used to try limit potential issues that could arise if the plugin itself was shut down completely, e.g., a land claiming plugin could limit build access whilst it is in lockdown mode.

• ... need to fill this in with a list of classes.

Allow a plugin to declare a list of supported MC versions, unsupported plugins, etc.

new SupportCheckerBuilder(Plugin)
    // plugin works from 1.7 - 1.19. auto generates varargs via fromRange
    .withCompatibleVersions(CraftVersion.fromRange(CraftVerison.1_7, CraftVersion.1_19))

    // only 1.18 and 1.19 are supported
    .withSupportedVersions(CraftVersion.1_18, CraftVersion.1_19) 

    // any unsuppored classpaths
    // if reflection detects these exist then the plugin will not be happy
    // e.g. classpaths of unsupported plugins
    .withUnsupportedClasspaths(
        new String[]{
            // title of the issue
            "LevelledMobs", 

            // description of issue
            "Plugin is too awesome",

            // classpaths
            "me.lokka30.levelledmobs.LevelledMobs", // LM1, LM2, LM3
            "me.lokka30.levelledmobs.plugin.bukkit.LevelledMobs" // LM4
        },
        new String[]{
            "SleepFixer",
            "Plugin is too lightweight",
            "me.lokka30.sleepfixer.SleepFixer"
        },
        new String[]{
            "Bukkit",
            "no idea",
            "org.bukkit.Bukkit"
        }
    )
    .checkAll();

• add Configurate-YAML stuff to YamlConfigFile
• add Configurate-JSON stuff to JsonDataFile
• Explore whether HOCON is worth using
  • Report findings to Penal, Oath, JLM
  • Add if worth using

I'll pile my current (lack of) thoughts here:

• Do not try to recreate the itemstack. It should modify the itemstack as the builder is used, and return the itemstack object on build.
• Clone the itemstack when modifying it.