-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/PrideHacks2023/vina
- Loading branch information
Showing
15 changed files
with
124 additions
and
41 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,13 +1,62 @@ | ||
<div align="center"> | ||
|
||
# vina | ||
<img src="media/logo.png" alt="vina" /> | ||
|
||
Ai generated visual novel | ||
AI-powered visual novel generator | ||
|
||
[![crates.io](https://img.shields.io/crates/v/vina.svg)](https://crates.io/crates/vina) | ||
[![docs.rs](https://docs.rs/vina/badge.svg)](https://docs.rs/vina) | ||
[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](#) | ||
|
||
</div> | ||
|
||
**VinA** is a visual novel generator. Once you specify a prompt on the type of | ||
story you want, we generate an entire plot, detailed characters with | ||
personalities, locations, music, and more. The result is a fully playable | ||
and polished visual novel you can play. | ||
|
||
## Example | ||
|
||
With the following prompt: | ||
``` | ||
Write a sci-fi story about a hackathon project gone haywire, where twofriends are working | ||
together on a coding project over the weekend. Then, they are sucked into their laptop and | ||
have to find a way back to reality. They overcome an obstacle and successfully return back home. | ||
``` | ||
|
||
We get this visual novel. | ||
|
||
## Features | ||
|
||
Dynamic facial expressions depending on the dialogue | ||
<div> | ||
<img src="media/lisa_base.png" width="30%" /> | ||
<img src="media/lisa_cry.png" width="30%" /> | ||
</div> | ||
<div> | ||
<img src="media/alex_base.png" width="30%" /> | ||
<img src="media/alex_anger.png" width="30%" /> | ||
</div> | ||
|
||
Generated background images for each scene | ||
<div> | ||
<img src="media/bg0.png" width="70%" /> | ||
<img src="media/bg1.png" width="70%" /> | ||
</div> | ||
|
||
## Usage | ||
|
||
To run **VinA** for yourself, you need the following: | ||
- An OpenAI API key, find out how to get one [here](https://platform.openai.com/docs/api-reference/authentication) | ||
- An instance of Automatic1111's stable diffusion web UI, ensure the instance you are using has API support. More info [here](https://github.com/AUTOMATIC1111/stable-diffusion-webui) | ||
- RenPy, installation instructions are [here](https://renpy.org/doc/html/quickstart.html) | ||
|
||
The following environment variables should be set: | ||
- `REN_PATH`: path to renpy executable | ||
- `OPENAI_KEY`: your openai API key | ||
- `NOVELAI_URL`: url to your instance of the stable diffusion web UI | ||
|
||
## What's with the name? | ||
|
||
**VinA** is an anagram of the much less creative name, 'AI VN'. | ||
|
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
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.