Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Commit

Permalink
docs(global): ✏️ update readme file
Browse files Browse the repository at this point in the history
Closes: #6
  • Loading branch information
kiochan committed Jul 21, 2023
1 parent ef4ba99 commit c5d23da
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
# esora

Framework for web visual novel development

_This project is still under development and you should **not** enable it in production._

## Getting Started

1. Clone the repository

```bash
git clone git@github.com:kiochan/esora.git
```

2. Install dependencies

```bash
npm install
```

3. Build the project

```bash
npm run build
```

4. ~~Run the project~~ **still under development**

## Roadmap

- Renderer (basic)
- [ ] basic rendering
- [ ] live2d support
- [ ] basic animation support
- Mocap Studio (basic)
- [ ] basic user interface
- [ ] motion capture
- [ ] live preview
- [ ] animation recording
- [ ] wight editing
- [ ] node-based animation editing
- [ ] file format for model and animation `*.ecm` (esora character model)
- Streaming Studio (basic)
- [ ] basic user interface
- [ ] load live2d model
- [ ] load model `*.ecm` from mocap studio

## Cooperation

If you want to contribute code, please refer to [CONTRIBUTING](./CONTRIBUTING.md)

## License

This project is licensed under the [MIT](./LICENSE) license.

0 comments on commit c5d23da

Please sign in to comment.