Release 2.0

Release 2.0 Summary

Complete restructure of the library, now abstracts away a lot of the functionality which previously required developers to implement manually.

Check out the updated README for more info.

Short list of changes:

• New central object which facilitates all communication with the server.
  • ArchipelagoSession which can be created by the static class ArchipelagoSessionFactory.
• Helper classes exposed by ArchipelagoSession
  • LocationCheckHelper which assists with sending location checks as well as retrieving info on locations via id or name.
  • ReceivedItemsHelper which assists with receiving items from the server as well as retrieving info on items via id or name.
  • PlayerHelper which assists with retrieving information about other players via player id.
• Socket level access may be done by using the ArchipelagoSocketHelper object exposed by ArchipelagoSession.
• DataPackage is now automatically retrieved and cached. Developers are not required to listen for it anymore.
  • DataPackage is no longer exposed and is entirely used internally in order to facilitate LocationCheckHelper and ReceivedItemsHelper.

Detail of What's Changed

• Implemeted missing enums + DataPackageVersions by @JarnoWesthof in #10
• Rename ItemsChecked to LocationsChecked by @JarnoWesthof in #12
• Added enum for connection errors by @JarnoWesthof in #11
• Implemented new Permissions for 0.1.9 by @JarnoWesthof in #15
• Remove outdated DataPackage keys by @Berserker66 in #14
• Revert "Remove outdated DataPackage keys" by @Ijwu in #16
• Refactoring + Extensions by @JarnoWesthof in #17
• Development player helper by @JarnoWesthof in #19
• Added LogonResult to connect method by @JarnoWesthof in #20
• Release 2.0 by @Ijwu in #13

New Contributors

• @JarnoWesthof made their first contribution in #10
• @Berserker66 made their first contribution in #14

Full Changelog: 1.3...2.0

Release 1.3

• Supports Unity 2018+ (.netstandard 2.0)
• ArchipelagoSession now has an event hook for socket disconnects.
• ArchipelagoSession now has ConnectAsync and DisconnectAsync methods. (Do not require async/await.)

Release 1.2.1

Fix JSON annotations in GameData class so that DataPackage packets are properly deserialized.

Release 1.2

• Updated for AP 0.1.5.
• New packet deserialization mapping.

Release 1.1.1

• Fix property names and add missing enum values.

Some info was incorrect in the official docs, this library and the docs are now altered to be correct.

Release 1.1

• Packets updated to correct structure as of July 11, 2021.
• Add missing packets, either in structure or in the packets enum.
• Code formatting (dev internal change).
• Downgrade newtonsoft and use my own websocket-sharp DLL to attempt to be more compatible with older .NET versions.
• Add enums for some otherwise ambiguous arguments in RoomInfoPacket and PrintJsonMessagePacket classes.