Vyi 1.62.0

What's Changed

• fix getStateNames reference error by @doubleactii in #5
• Fixes #6 Getting a vyi from a frame returns undefined. by @doubleactii in #8
• fixes #7 by @doubleactii in #9

Implements the ability to export a vyi as a binary string for saving.

Full Changelog: v1.61.0...1.62.0

Vyi 1.61.0

Vyi 1.61.0 What's Changed

Changelog

• Added new API to the Icon class.

const stateNames = iconRef.getStateNames() // This returns an array of all the names of each state this icon has.

Full Changelog: v1.6.0...v1.61.0

Vyi v1.6.0

Vyi 1.6.0 What's Changed

Better typing. JSDOC annotations are more carefully observed to annotate which thing should be private.
Which params should be optional and so on.

Bug fixes

The removeState API was incorrectly referencing a variable it did not have.

Full Changelog: v1.5.0...v1.6.0

Vyi v1.5.0

Vyi 1.5.0 What's Changed

• vyi v1.5.0 by @doubleactii in #4

Release Notes

New Features

• New APIs added:

  • removeIconByName(name: string): Removes an icon by its name.
  • removeIconById(id: string): Removes an icon by its Id.
  • removeFrameByIndex(index: number): Removes a frame by its index.
  • removeStateById(id: string): Removes a state by its Id.
  • removeStateByName(name: string): Removes a state by its name.
  • getWidth(): Retrieves the width of the component. This is for frames, as well as icons
  • getHeight(): Retrieves the height of the component. This is for frames, as well as icons
  • getStateCount() Retrieves the number of states in the icon.
  • getFrameCount() Retrieves the number of frames in the icons.
  • getIconCount() Retrieves the number of icons in the vyi. This is for the vyi instance only

  See docs for more detailed info: https://evitcastudio.github.io/vyi/

• API Enhancements:

  • addIcon(), addFrame(), and addState() APIs now allow passing existing Icon or Frame instances, offering greater flexibility in handling instances.

Improvements

• Icon and Frame Behavior:
  • Icon and Frame classes no longer require passing the owner during construction. This allows using Icon and Frame instances independently before attaching them to a vyi or an icon.

Bug Fixes

• JSDoc Annotations:
  • Fixed incorrectly typed JSDoc annotations to improve the development experience and ensure accurate documentation.

Refactoring & Performance

• Internal Data Structure Changes:

  • Arrays used for internal storage have been refactored to Maps, resulting in quicker lookup times and more efficient operations.

• Code Cleanup:

  • Internal code has undergone cleanup for improved readability and maintainability.

New Contributors

• @doubleactii made their first contribution in #4

Full Changelog: v1.4.0...v1.5.0

VYI v1.4.0

v1.4.0

Overview

This release introduces several enhancements to the VYI module, improving usability and functionality. Key updates include the addition of decompression support for binary files, new API methods for easier data retrieval, and a transition to JSDoc as the documentation generator.

Key Changes

• Pako Decompression

  • Feature: Added support for decompressing files that are still in their binary form. This is useful because files in the .vyi format often come either compressed or decompressed. This module now handles the decompression.

• New API Methods

  • getParent: returns the Icon instance that the callee belongs to.
  • getName: returns the name of a specific icon instance.
  • getVyi: returns the VYI instance that the callee belongs to.
  • rename: VYI instances now have the ability to rename themselves.

These new methods simplify lookups and enhance the usability of the VYI API.

• Documentation Improvements
  • JSDoc Integration: Switched from ESDoc to JSDoc as the documentation generator.

Benefit: The new documentation is more accessible and easier to navigate, providing comprehensive information about the VYI module and its capabilities.

Full Changelog: v1.3.0...v1.4.0

VYI v1.3.0

v1.3.0

This update brings a helpful feature: assigning unique IDs to icons. In the vyi format, multiple icons could share the same name, and when you searched for an icon, it would only find the last one with that name. Now, with each icon having its own ID, you can search for and target specific icons even if they share the same name, making it easier to work with them.

Full Changelog: v1.2.1...v1.3.0

VYI v1.2.1

v1.2.1

This update adds the functionality mentioned in #1.
It allows every icon, state, and frame to reference the VYI it belongs to.
This also allows every icon, state, and frame to reference its parent.

Full Changelog: v1.1.0...v1.2.1

VYI v1.1.0

v1.1.0

This update addresses an issue where it wasn't aligning with the VYI spec. Where when using the setAllFrameDelays API it did not take into account the parent icon's delay.

Full Changelog: v1.0.21...v1.1.0

VYI v1.0.21

v1.0.21

This update addresses an issue where it wasn't aligning with the VYI spec. Where duplicate state names were being referenced via the first name found, rather than the last.

Full Changelog: v1.0.2...v1.0.21

VYI v1.0.2

Fixes an issue where the logger was incorrectly referenced.

Full Changelog: v1.0.1...v1.0.2