This repository has been archived by the owner on Mar 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✅ Closes: #6
- Loading branch information
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |