Skip to content

Commit

Permalink
docs: update readme for proper editor support!
Browse files Browse the repository at this point in the history
  • Loading branch information
purifetchi committed Dec 4, 2022
1 parent 46ba3f3 commit 767a125
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
Binary file added Meta/editor.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# VTubeTiny
VTubeTiny is a small VTuber/PNGTuber suite (written in C# and utilizing Raylib) for easily and quickly animating png models.

**VTubeTiny stage view**

![Demo](/Meta/vttiny.gif)

**VTubeTiny editor**

![Editor Demo](/Meta/editor.gif)

## Requirements

* .NET 5
* Windows 7+ (64-bit)
* A GPU that supports OpenGL ES 3.

## Usage
All of the VTubeTiny data is described in a JSON config file, from which VTubeTiny generates the **Stage**. Every **Stage** is split into **Actors**, which can have **Components** attached to them. Components serve multiple purposes, from rendering textures or text, to animating characters based on the microphone levels.

Expand Down Expand Up @@ -50,6 +62,17 @@ VTubeTiny.exe -f config.json

By default, VTubeTiny launches with an empty stage.

## Editor

VTubeTiny features a fully fledged editor mode which you can enter by launching VTubeTiny with the `-e` parameter, like so:

```
VTubeTiny.exe -e
```

It allows for full stage editing, exporting, actor editing and more! It completely erases the need to construct configuration files by themselves.


## Extensibility

VTubeTiny can be extended with custom components. All that's neccessary is deriving from the *Component* class, and implementing any of the component functions. (implementing InheritParametersFromConfig is required for loading from the config file.)
Expand Down Expand Up @@ -109,8 +132,9 @@ namespace VTTiny.Components
Now, if we were to attach this component to an actor and enter editor mode, the component's dimensions will be fully editable!

## Future Goals
* An internal editor where you can instantiate actors and components at runtime and move them.
* Exporting Stages from within VTubeTiny.
* Proper cross-platform support.
* Getting rid of Newtonsoft.JSON to reduce RAM usage.
* More components!

## Contributing Guide
If you'd really want to contribute to this project (thank you!) please adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) commit format as much as you can.

0 comments on commit 767a125

Please sign in to comment.