Releases: Miner28/AvatarImageReader
Update 3.0 - UTF8, optimizations, better editor, read-only mode
Requires UdonSharp >1.0 and VRChat Creator Companion version of VRCSDK3
UTF8 support
Added support for encoding and reading UTF8, which in most cases will have lower byte usage than UTF16.
Choose between UTF8 and UTF16 depending on what you are encoding.
Custom Encoders
Header has been updated, now includes Terminator pixel, Data Type, Encoder Version and Encoder Type. Make sure to check C# Encoder's implementation for more details.
Read-only mode
When AvatarImageReader detects a project without VRChatApiTools AIR will be put into read-only mode. The Encoder will not work in this mode.
Installation
Import with VRChat Creator Companion:
- Download the the repository's .zip here
- Unpack the .zip somewhere
- In VRChat Creator Companion, navigate to
Settings
>User Packages
>Add
- Navigate to the unpacked folder,
com.miner28.avatar-image-reader
and clickSelect Folder
Avatar Image Reader
should now be visible underLocal User Packages
in the project view in VRChat Creator Companion- Click
Add
Import with Unity Package Manager (git):
- In the Unity toolbar, select
Window
>Package Manager
>[+]
>Add package from git URL...
- Paste the following link:
https://github.com/Miner28/AvatarImageReader.git
Import from Unitypackage:
- Download latest Avatar Image Reader from here
- Import the downloaded .unitypackage into your Unity project
Update 2.1 - MultiAvatar loading fix, encoding fix, timing changes.
- Fixed C# encoder to work with MultiAvatars.
- Speed no longer depends on stepSize, but instead is variable for every user and is dependent on frameTime.
What's Changed
Full Changelog: v2.0...v2.1
Update 2.0 - Multi Avatar Loading, Alpha Channel Encoding, New Inspector
What's Changed
- Provide a C# implementation of "gen.py" encoder by @hai-vr
- Increased data density to 32 bits per pixel, increasing the total data storage space per image by 33%
- Increased decoding speed by optimising decoder code (made possible by the simpler data format we now use) by @Miner28
- Added the ability to specify the next avatar to load in the header of the initial avatar, making it possible to load an infinite amount of data (only limited by decode and image load speeds) by @Miner28
- New inspector to simplify use and setup by @BocuD
- Avatar Image updates from inspector by @BocuD
When updating, make sure to delete your Assets/AvatarImageReader folder!
This project now relies on VRCApiTools to upload images, which you can install from here. Please note that if you already have a previous version installed (installed by pre release versions of AvatarImageReader or VRBuildHelper) that you'll have to first uninstall it as described in the release notes for VRChatApiTools.
If you are using a custom encoder, this new version requires you to update it! There is now a header that will always contain Avatar-ID or BLANK Avatar-ID. Look into Assets\AvatarImageReader\C# Encoder\AvatarImageEncoder.cs for an example. (detailed documentation will be added soon)
This version also works with an experimental public discord bot which handles automatic uploading of discord users into world and their linking.
Discord bot invite: https://discord.com/api/oauth2/authorize?client_id=938573401201721425&permissions=2147600448&scope=bot%20applications.commands
For help message: Miner28_3#3607
Quest support and 24bpp data
v1.1 Clean up project