v9.1.0-beta

[Redforce04]

AutoEvent v9.1.0-beta

By Redforce04 and KoT0XleB

Disclaimer

Many changes are included in this Beta release. The documentation is currently being updated to reflect these changes.
Please be aware that this is a beta update, and events, and the framework may not be fully stable. Please either DM any bugs to Redforce04 on discord or create an issue in the official github.

Added Features:

Breaking Changes:

• 4 new configs have been added that allow you to change where the following directories live:
  • Events - the external event directory
  • Schematics - the schematics directory
  • Music - the music /audio directory
  • Configs - the event configuration directory
  • By default these have moved to the following locations. Please move these folders to reflect these changes, or change the default config.
    • NWApi:
      • Original Location: ~/.config/SCP Secret Laboratory/PluginAPI/plugins/global/*
      • New Location: ~/.config/SCP Secret Laboratory/PluginAPI/plugins/global/AutoEvent/*
      • (Default Configs have also moved from /plugins/global/AutoEvent-NWApi/configs -> /plugins/global/AutoEvent/Configs)
    • Exiled:
      • Original Location: ~/.config/EXILED/Configs/*
      • New Location: ~/.config/EXILED/Configs/AutoEvent/*
  • Dependencies are all managed via Costura.Fody. You no longer need to add any dependencies.

Config System:

• Each event can now have its own configs.
  • Configs are located as following:

   ~/AutoEvent/Configs/
       ExamplePlugin/
           Config.yml
           Presets/
               Preset1.yml
               CoolPreset.yml    
  

• Each event can now have various presets.
• You can make a preset by copying the original config into a new yml file in the presets directory.
• Presets can be selected ingame via the following commands:
  • ev config list [event name] - lists all presets for an event.
  • ev config select [event name] [preset name] - selects a preset for an event (default can be used to use the default config.)
• More information about configs coming soon.

Commands:

• Several new commands have been added to aid developers and users alike.
• New commands include:
  • ev config [option] - config parent command.
    • list [event name] - list all presets available for an event.
    • select [event name] [preset name] - select a preset to use for an event.
  • ev reload [option] - reload parent command.
    • events - reload all events. This can be used to register new external events (added in the events folder)
    • configs - reload all configs and config presets from the files.
    • translations - reload all translations from their files (currently this does not yet work.)
  • ev debug [option] - debug features parent command.
    • enable - enable debug logging to console.
    • disable - disable debug logging to console.
    • antiend [enable/disable/*toggle*] - prevents events from ending. (must implement AntiEnd in the event).
    • write - write all errors and debug outpus to /AutoEvent/debug-output.log.
    • presets [option] - list registered presets for an event.
  • ev volume [volume percent 0 - 200] - sets the global volume level for all events.

External Events:

• Developers can now create their own events and upload them to the ~/AutoEvent/Events directory.
• Events can be developed in Exiled or NWApi.
  • Exiled events must inherit the IExiledEvent interface or it can cause issues if Exiled is not present.
• Events can be built with the Event class and can be set to automatically register when placed in the /Event directory.
  • (No need to make a whole plugin just for a few events)
• Events can also be built as NWApi / Exiled plugins and can manually be registered to AutoEvent.Events.

API Overhaul:

• The event plugin now offers several more methods for developers to build with.
• We have abstracted several of the more nuanced items, and made them more automated.
• New Interfaces Include:
  • IEventSound - for incorporating music into events
  • IEventMap - for incorporating schematics into events
  • IExiledEvent - for exiled events.
• Configs are easier than ever to add:
  • Create a new non-static class that inherits the EventConfig class.
  • Define settings as public properties that has public { get; set; } methods.
  • Use [YamlIgnore], [YamlMember], and [Description] to add more information / custom parsing to properties.
  • In the main event class, add a property for the new config class with public { get; set; } and the [EventConfig] attribute.
  • The config will be automatically loaded when the event is registered.
• Config presets can be added and selected.
  • Use a static method to return a custom instance of the config class that you created.
  • Define a property with public { get; set; } that is the same type as the main config type.
  • Use the [EventConfigPreset] attribute above the type.
  • Config Presets will be saved in the event's preset folder, with the name of the preset's property.
  • Users can modify and select presets before or while running events.
  • When a presets is selected, it will update the original [EventConfig] Property in the plugin.
• Look at the updated ExampleEvent for more info about the Event Configs, and Config Presets.
• New API methods have been added. You can delay the start of music, or spawning of the map.
• Event Coroutines have been abstracted and simplified. Look at ExampleEvent or any of the other events for more information.
  • The coroutine can be overriden for Developers that prefer the older method.
• Cleanup methods have been abstracted.

Translations:

• Many English translations have been updated to be more concise for native English speakers.
• If you want to help us improve our translations, please reach out to Redforce04.
  • You can also create an issue on GitHub or create a pull request with updated Translations.

Other changes:

• All dependencies are now managed by Costura.Fody, and are embedded directly into the plugin, and loaded at runtime.
• All events and core features are now built around NWApi.
  • Exiled version utilizes a separate build that only changes necessary features to run off of Exiled. (similar to CedMod and other Plugins)
  • This tremendously reduces the amount of development overhead.
  • External events can still be made for Exiled. Just inherit IExiledEvent.
• More Extensions are available for developers.
• Several classes have been added to make configs more streamlined:
  • Loadouts, Effects, RoleCount and more.

Upcoming Features:

• CedMod Events Integration
• Scripted Events Integration
• Custom Items
• Custom Roles
• More Commands
• More Events
• More Features
• More Extensions and API Changes to Simplify Development
• Updated Documentation
• Lobby map, and auto event manager. (24/7 event servers)

Suggestions and Feedback:

• If you would like to leave feedback or suggestions, please feel free to send us a message on discord, or create an issue on GitHub.
• You can also reach us via our NWApi and Exiled Forums.
• We are glad to have a great playerbase that supports us and give us feedback.

---

This discussion was created from the release v9.1.0-beta.