Hey everyone!
I got another fun holiday treat for you! We're introducing ResoniteLink! A simple WebSocket JSON protocol for working with the data model from external apps, scripts and tools!
This is an open project whose goal is to significantly increase Resonite's interoperability. It's a building block for building stuff like Unity SDK (and other game engines), integrations with various software or just playing around with Resonite from external scripts and tools.
There's lots of possibilities, I recommend checking out the repository linked below to learn more.
This is also currently in beta, so breaking changes can occur and some things are still missing, but coming soon! Give it a try and let us know what you think (and show off what you build with it)!
New Features:
- Implemented ResoniteLink - a new protocol for working with the data model from external tools, scripts and apps
-- This allows you to read & write data model in worlds that you host over simple JSON WebSocket protocol
-- Client library & reference C# implementation & sample REPL client is available under MIT license here: https://github.com/Yellow-Dog-Man/ResoniteLink
-- Note that the protocol & library is currently in beta! We're looking for feedback on it and are open to breaking changes until the label is removed.
-- The library & protocol is also work in progress and will also be expanded with additional commands soon and support for more of the data model (see the README in the repository above)
-- This is going to be a building block for an official Unity SDK as well as any community tools and integrations (issue #6)
-- To access a world with ResoniteLink, it needs to be enabled first. Only host can do this. There are multiple ways to do so:
--- In graphical client, go to Sessions and click "Enable ResoniteLink"
--- In headless config, you can add `enableResoniteLink` and optionally `forceResoniteLinkPort` config options
--- In a running headless you can also use the `enableResoniteLink ` command (use 0 for random port)
-- Certain objects are excluded from ResoniteLink - e.g. hierarchies under SimpleAvatarProtection that you don't own. Intentionally bypassing these protections with mods is not allowed under our policy: https://resonite.com/policies/ModAndPlugin.html
-- Shoutout to @j4.lc for setting up NuGet CI/CD and @earthmark for first community contribution!
Locale:
- Merged Japanese locale update by @.aesc and @markn2000
- Merged German locale update by @muppeq and @cameron5
- Merged Chinese locale update by modimobeikete
Fixes:
- Patch issue when auto-spawning items via the headless configuration file (reported by sctanf, issue #1107, fixed by @j4.lc)