Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Balphagorevr authored Jan 9, 2024
1 parent 09e6751 commit 9f7aead
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Udon Data Reader
Udon Data Reader is an editor library providing an API to read Serialized Udon Programs to provide symbols, entry points and other metadata about the Udon program.

## Disclaimer

This project is in beta and early development, there will be a lot to add as I come up with ideas or receive feeback.

## Getting Started

### Creator Companion
1. Add my VCC Repository listing by visiting my [Listing Page](https://balphagorevr.github.io/balphagore-vcc-listings/).
2. Select your world project and click "Manage Project".
Expand All @@ -17,27 +12,31 @@ This project is in beta and early development, there will be a lot to add as I c
![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FBalphagorevr%2FUdonDataReader%2Fmain%2FPackages%2Fcom.balphagore.udondatareader%2Fpackage.json&query=%24.version&label=VPM%20Release&color=green&link=https%3A%2F%2Fgithub.com%2FBalphagorevr%2FUdonDataReader%2Freleases)


## API Methods
## API Methods & Documentation

|Method Name|Returns|Details|
### UdonDataReader Class
|Static Method|Returns|Details|
|---|---|---|
|GetProgramData()|UdonProgramData|Returns a UdonProgramData Object consisting of valid data read from the serialized Udon Program asset.|
|LoadUdonBehaviour(UdonBehaviour behaviour)|Void|Loads the given UdonBehaviour object onto the Data Reader for reading.|
|ReadUdonProgram(UdonBehaviour Object)|UdonProgramData|Returns a UdonProgramData Object consisting of valid data read from the serialized Udon Program asset referenced by the provided Udon Behaviour.|

## Roadmap
### UdonProgramData Object
Holds information and metadata read from an Udon Program asset file.

### UdonSymbol Object
An Udon Symbol from the Udon Program that represents a variable or method.

## Roadmap
### Next Release
N/A - initial requirements have been met for a project. If there is feedback provided in the issues tracker, I will consider enhancements.

#### 1.1.0
## Changelog
### 1.0.0
* Public release

### 1.1.0
1/8/2024
* Created editor window demonstrating use of the API and providing a basic display of the Udon program and its symbols.
* Add support for getting source compiler names/versions.
* Separate symbols vs. exported symbols.
* Separate entry points vs. exported entry points.
* Get Sync metadata data.

#### 1.2.0
* Potential optimizations.
* Add Example Script and basic Editor window demonstrating use of Udon Data Reader.

## Changelog
### 1.0.0
* Public release

0 comments on commit 9f7aead

Please sign in to comment.