Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Smidgens committed Aug 11, 2022
1 parent 09af88a commit d29df3c
Showing 1 changed file with 19 additions and 24 deletions.
43 changes: 19 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,22 @@

## ℹ️ Features

* Reflection-assisted console.
* Minimal but functional UI (Unity IMGUI).
* Usable with existing code by default.
* Bind commands in editor or at runtime.
* Call static methods and properties.
* Reflection-based runtime console for Unity projects.
* No extras required - usable with existing code and wireable through inspector.
* Bind handlers for scene objects or project assets.
* Supports input and parsing of all primitive type arguments + common Unity structs (Vector2/3/4, Color...).
* Multiple input conventions supported (fn(x), fn x, variable=x)
* Minimalistic and functional UI (Unity IMGUI).
* 🤞 Reasonably lightweight.
<br/>


**⌛ In Progress**

* [ ] Static methods and fields.
* [ ] Optional method parameters
* [ ] Automatic type casting for compatible types (float -> double...)
* [ ] Custom input parsers and type handlers.

<br/>

Expand All @@ -20,27 +31,11 @@

<br/>

## 🚀 Usage
## 🚀 Use


**Bare Minimum**

1. Create a `Console` asset in your project.
2. Add the `ConsoleGUI` script to your scene and drop a reference to the asset into it.

### Instance

todo
2. Add a `Console GUI` script to your scene and drop a reference to the asset into it.
3. Use `Console Handler` script to bind commands to scene objects.


#### Scene

todo


### Static


<br/>

##

0 comments on commit d29df3c

Please sign in to comment.