Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sr229/sayori
render your prose/poems like it's Doki Doki Literature Club!
https://github.com/sr229/sayori
ddlc pillow python streamlit
Last synced: 6 days ago
JSON representation
render your prose/poems like it's Doki Doki Literature Club!
- Host: GitHub
- URL: https://github.com/sr229/sayori
- Owner: sr229
- License: other
- Created: 2023-03-19T10:00:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-22T08:39:49.000Z (12 months ago)
- Last Synced: 2024-05-01T14:53:12.201Z (7 months ago)
- Topics: ddlc, pillow, python, streamlit
- Language: Python
- Homepage: https://sayori.streamlit.app/
- Size: 1.45 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Sayori - render your prose/poems like it's Doki Doki Literature Club!
[](https://ko-fi.com/Y8Y6Y0W4) [](https://codesandbox.io/p/github/sr229/sayori)
Sayori allows you to add more flair to your poems or proses and render them in Doki Doki Literature Club's style, using Python's PIL module to generate images for you to share!
Sayori can generate images with the following parameters:
- The text (can be uploaded as a plaintext file as well if you fancy that!)
- Background Type (Normal, or Yuri (Obsession Level from 2-3))
- The characters' writing styles (Monika (by default), Sayori, Natsuki, Yuri (and her obsessed variants))
## Try it for yourself!
Sayori is hosted on [Streamlit!](https://sayori.streamlit.app/)
However, if you want to integrate the project to your application, a hosted API is available as well! You can find it [here](https://sayori.fly.dev). Documentation for the API version can be found [here](./WEBSERVER_API.md).
## Installation
Sayori requires a modern Python installation to work. It is recommended to use Python 3.6 or above. As for the dependencies, don't worry about that! It's provided in the requirements.txt file, so you can just run:
```bash
$ pip install -r requirements.txt
```
To run the web application, simply run
```bash
$ streamlit run streamlit_main.py
```
## Development
Sayori takes advantage of the Virtual Environments feature in Python. To develop for Sayori, you must make a venv first:
```bash
$ python -m venv $(pwd)/.venv
```
Then finally activate your virtual environment
```bash
$ source $(pwd)/.venv/bin/activate
```
This ensures a consistent environment regardless of your development environment settings. After switching to the new
virtual environment, simply follow the [Installation](#installation) instructions.
## Copyright
Copyright © 2023 Ayase Minori. All Rights Reserved. Licensed under the MIT License. See [LICENSE](./LICENSE) for more information.
Assets used in this project are property of Team Salvato and are used for educational purposes only. No infringement intended.