Skip to content

Unity plugin that can read asset bundle data in varying ways to validate the contents

License

Notifications You must be signed in to change notification settings

srowlandsdev/unity-abreader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ABReader

ABReader is a Unity plugin written in C# and intended as a validation tool that can be used during development to validate the contents of generated asset bundles for releases. It can be used to point at an individual asset bundle or collection by selecting the parent folder then retrieve information from them. The tool uses Unity standard API calls to meet this goal. In addition, it has custom functionality to export the data into JSON and also add a custom logging class to provide user feedback in the editor and the log file

Project Features:

  • Read an array of Unity asset bundles by way of passing a folder path or single file path where they are located on disk
  • Export the asset bundle(s) available data into the JSON data structure format
  • Custom debug logging class and methods to provide detailed output for the ABReader system
  • Read asset bundles from within an archive (OBB, APK, ZIP) and also extract them to a local directory
  • Export the asset bundle entry data from an archive (OBB, APK, ZIP)

Installation

Installation is simple and you can either opt to install by importing the .unitypackage I have provided in the releases or download, extract and add the source code into the Editor folder on your Unity project.

Once you have installed the tool then refer to the in editor toolbar for a new header called ABReader, click it and the options are presented in a list

Usage

Using ABReader is nice and simple, all of the methods are called from the toolbar under "ABReader". From there the options are split into Asset Bundle File,Asset Bundle Folder or Compressed Archive(For zip, obb or apk)

Asset Bundle Folders

  • Select ABReader >> Asset Bundle Folder
  • Choose from: Read From Folder, Read From Folder Async or JSON Export
  • Select the folder where the bundles are located using the pop up file explorer

Asset Bundle Files

  • Select ABReader >> Asset Bundle File
  • Choose from: Read From File, Read From File Async or JSON Export
  • Select the bundle file using the pop up file explorer

Compressed Archives

  • Select ABReader >> Compressed Archive
  • Choose from: Read From Archive or JSON Export
  • Select the zip/archive file where the bundles are compressed to using the pop up file explorer

Known Issues

  • Cancelling the file explorer popup and not selecting a folder results in: ArgumentException: The specified path is not of a legal form (empty) #2
  • If the folder contains more than bundle files then the read will throw and error for those file(s): Unable to read header from archive file: #1

About

Unity plugin that can read asset bundle data in varying ways to validate the contents

Topics

Resources

License

Stars

Watchers

Forks

Languages