Skip to content

[email protected]
Compare
Choose a tag to compare
@ThePhar ThePhar released this 08 Jul 15:20
· 191 commits to main since this release
1.0.0
5c1ed76
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

What's Changed

  • Changes to how connection information is passed to Client.connect.
  • Changed name of ArchipelagoClient back to Client.
  • Utilize Vite for bundling instead of Webpack. (reverted in 1.0.1)
  • More examples in README.md and updated documentation.
  • Changed names of events for Client.addListener and Client.removeListener
  • Turned most interfaces into types.
  • Turned all enums into consts.
  • Added a HintManager class to Client. Currently only keeps track of own hints.
  • Changed how name and id lookup for items and locations work in preparation for ArchipelagoMW/Archipelago's PR 1933. Lookups require game name as well. This will eventually allow each world to use any id without worry of id collisions.
  • Added a helper class for doing complex set operations in DataManager.
  • Client will no longer request entire DataPackage from Archipelago server. Only for games that exist in room.
  • Add item group and location group names to DataPackage and add checksum support. Still no caching is built in, but is prepared for a future update.
  • Added hintPoints, hintCost, slotData, slot, team, seed, and permissions properties to DataManager for real-time room information. Updates when room updates.
  • Improved name lookup and added id lookup for ItemsManager and LocationsManager, as part of look up changes.
  • Added group lookup for ItemsManager and LocationsManager to pull all items in a given group name for a game.
  • Changed type of Client to Client<SlotDataType> for TypeScript users to specify the structure of their slot data in advance for better typing information.
  • Improved checked and missing locations array properties in LocationsManager to actually work.
  • Added game name lookup method for a player id in PlayersManager for easy lookup since in all contexts you you need name for id of location or item, you have the player id.
  • Added members method in PlayersManager to look up all players in a given Item Link group. Returns empty list if not an item link group.
  • Removed a lot of redundant code.
  • Improved type hinting and inference.
  • Removed all mentions of version in DataPackage and GamePackage. Planned to be removed from AP in PR 1933.
  • Added all the newer PrintJSONPacket types and their appropriate args.
  • remaining is now a ReducedPermission type instead of Permission since it can't have AUTO-type permissions.
  • players property in DataManager is of a type that's a combination of NetworkPlayer and NetworkSlot to have all information together after connection.
  • Added WSS support.
  • Added Hint type. Used by HintManager class.
  • Adjusted build settings.
  • And probably a bunch of bug fixes that I forgot about.

This is a very breaking API change, but hoping to keep it stable for the most part for a while now. If you notice any issues, please reach out to me here or in Discord (thephar).

Thanks!

Full Changelog: 0.5.2...1.0.0

Assets 4
Loading