https://github.com/stephanakkerman/kanjicontrol
https://github.com/stephanakkerman/kanjicontrol
chinese hanzi hanzi-characters japanese kanji kanji-characters language language-learning mandarin mnemonic mnemonic-generator
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/stephanakkerman/kanjicontrol
- Owner: StephanAkkerman
- License: mit
- Created: 2025-03-18T19:57:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-26T20:24:25.000Z (about 1 year ago)
- Last Synced: 2025-03-26T21:31:07.330Z (about 1 year ago)
- Topics: chinese, hanzi, hanzi-characters, japanese, kanji, kanji-characters, language, language-learning, mandarin, mnemonic, mnemonic-generator
- Language: Python
- Homepage:
- Size: 19.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# KanjiControl
---
## Introduction
KanjiControl is a Python project that lets you create mnemonic images of given Japanse kanji and Mandarin Hanzi characters. It's simple to use, simply run `src/main.py` and give a character and its meaning. The program will then generate a mnemonic image for you, saved in the `output` folder.
It uses the QR Code Control Net by Monster-Labs to control the Stable Difussion 1.5 model.
### Examples
This is an example of a generated mnemonic image for the kanji character "木" (tree):
## Table of Contents 🗂
- [Installation](#installation)
- [Usage](#usage)
- [Citation](#citation)
- [Contributing](#contributing)
- [License](#license)
## Installation ⚙️
The required packages to run this code can be found in the requirements.txt file. To run this file, execute the following code block after cloning the repository:
```bash
pip install -r requirements.txt
```
or
```bash
pip install git+https://github.com/StephanAkkerman/KanjiControl.git
```
## Usage ⌨️
## Citation ✍️
If you use this project in your research, please cite as follows:
```bibtex
@misc{project_name,
author = {Stephan Akkerman},
title = {KanjiControl},
year = {2025},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/StephanAkkerman/KanjiControl}}
}
```
## Contributing 🛠
Contributions are welcome! If you have a feature request, bug report, or proposal for code refactoring, please feel free to open an issue on GitHub. We appreciate your help in improving this project.\
## License 📜
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.