Table of Contents

Changelog 2

You can't find the previous changelog here.

Introduction

This changelog documents what changed in the second update of the Plugins API.
Since this is very early-access and the API is still being developed, there will a lot of changes and breaking changes.
There will be a clear changelog for each update, so you can easily see what changed and what you need to do to adapt your plugin.
This update is pretty much the whole package, you need to update the client first, that should take care of the new runtime.
With the entry point from the version 1 runtime, you will have an error telling you there is a version mismatch with two identical versions.
Simply eject and re-inject or re-open the game and it should work after. Update the UI from the chat AFTER the client and runtime since if you update it before updating the client you will likely crash as there was a bug with unloaded plugins.

.plugin install uuid 50b8338a-1cc4-44ca-81ef-5ecf1062c37c

That will install the latest version of the Plugin Manager UI.

Breaking Changes

Runtime Changes

  • The runtime now has OnixRendererType to determine which renderer the user chose to use.
    • That's in Onix.Render.MainRenderer and it's not too useful to you, but we use it to determine which renderer to use for the new generic render events.
  • OnixModuleVisual now has a Render event you can subscribe to.
    • This is useful when rendering hud elements as just rendering where the module is located was very bug-prone and was bound to have edge-cases.
    • This even works with the preview in the client's UI.
  • OnixModuleVisual now has a Area property that returns a Rect representing the module's position and size.
    • Because dealing with a rectangle is so much more convenient than dealing with a position and size separately.
  • All the VertexBatch variants taking a List<VertexType> no longer causes an exception.
  • The .plugin command now has a ui subcommand to open the Plugin Manager UI.
    • You can also specify a plugin UUID to open a specific plugin's settings.
    • .plugin ui [uuid]
  • Fixed a freeze that occurred when loading an incompatible plugin.
  • Fixed all the bounding box rendering functions the incorrect front/back faces.
  • Added BoundingBox rendering functions that take a normal but no UVs.
  • The OnixSetting.SettingChanged callbacks no longer hard crash the runtime when invoked.
  • The OnixModules that have been created by a plugin now have an Open in Plugin Manager button.
  • Fixed an issue where it would change the runtime version but still report failure, requiring a restart to fix.

Client Changes

  • Now expects runtime version 2.
  • Fixed a freeze when too many notifications were sent from another thread than the main thread.
  • Modules opened from the hud editor now re-open correctly when they disappear for a brief moment.
  • Added a Never Trusted option in Developer Settings, which is enabled by default.
    • This will help you remember to check for trust when you create plugins, so you don't forget to do it later.
    • Since most testing happens in singleplayer where you are trusted, you might never realize you need to check for trust on some functions.
    • I would recommend having this on and testing with on before you release your plugin.

Plugin Manager Changes

  • Uninstalling a local plugin no longer causes multiple exceptions.
  • Implemented the ability to open a plugin by its UUID.
  • Incompatible plugins will now have a warning displayed on their card.
    • Details view still has nothing as it is unfinished at this time.

Plugin API Changes

  • Hopefully fixed the infinite update task.
  • Allowed the browser to cache some docs content.
    • That fixes the light mode blinding you for a split second on every single page load.
    • It also speeds up the loading of the docs for the next 30 minutes after visiting that page.
  • There is an endpoint to update the documentation from the Documentation Website Repository

Plugin Generator Changes

  • Fixed the OnHudInput event not returning false.
  • Fixed the OnHudInput not using the OnixRuntime.Api.Inputs namespace.
  • Fixed the OnChatMessage event not returning false.
  • Fixed the OnChatMessage not importing the OnixRuntime.Api.UI namespace.
  • Added the .editorconfig file to the generated project.
  • Renamed the Hudender event to HudRenderGame to better reflect its purpose and make it consistent with HudRenderDirect2D.
  • Added the new HudRender event to the plugin generator.
    • This one is a generic event that uses the user's preferred renderer.
    • You should prefer this for rendering unless you have a good reason to specialize.
  • Added an OS check for the rm/del commands to get rid of two warnings when building.
  • Ignored the return value of the asset copy step in the plugin generator.
    • This is to prevent the build from failing when the asset copy fails, which is not critical for the plugin to work.
  • Added a README.md file to the generated project.
Edit this page