---

Table of Contents

• Notes
• Dependencies
• Quick Start
• Settings Menu
• Vocab Settings
• Storage Settings
• Setting Up A MySQL Database
• License
• Contact

---

Notes

Built for Windows.

May work on Linux/Mac, attempts were made to make it cross platform, but no guarantees. I'd welcome any feedback on this.

Python Version: 3.8+

Tests the user on Japanese Kana and Vocabulary.

Seisen has a trello board for tracking planned features and bugs, you can find it here.

---

Dependencies

mysql.connector-python (optional)

or see requirements.txt

---

Quick Start

Run seisen.py

Upon opening the file, you will be prompted to enter database credentials, if you have these go ahead and enter these, otherwise enter z to skip.

Once at the main menu, press 1 and begin to quiz yourself on kana or 2 to quiz yourself on vocab.

All Japanese Kana and 7 Vocab words are included by default. You can add more vocab in the settings menu.

---

Settings Menu

pressing 3 will enter the settings menu. The settings are as follows:

1. Vocab Settings - Enters vocab settings
2. Storage Settings - Enters storage settings
3. See Score Ratings - this will print the likelihood of each kana/vocab being tested.
4. Set Up New Database - - this will cause Seisen to prompt for a new database.

---

Vocab Settings

Vocab Settings are as follows:

1. Add Entity - Allows you to add an entity to the vocab deck
2. Edit Entity - Allows you to edit an entity in the vocab deck
3. Delete Entity - Allows you to delete an entity from the vocab deck
4. Search Entity - Allows you to search for an entity in the vocab deck

Entity is a term to describe all "things" in the deck.

A Vocab is an entity, each vocab has a Reading, a TestingMaterial, and an Answer.

All of those are entities, meaning you can add, edit, delete, and search for them.

---

Storage Settings

1. Reset Local with Remote - Resets Local Storage with the Database (will do nothing if no connection)
2. Reset Remote with Local - Resets Remote Storage with the Local Storage (will do nothing if no connection)
3. Reset Local & Remote to Default - Resets all storage to default settings (remote will be unaffected if no connection)
4. Restore Backup - Prompts the user to restore either a local or remote backup
5. Export Vocab Deck - Exports the vocab deck to a .seisen file that can be imported by another user or yourself later
6. Import Vocab Deck - Imports a .seisen file that was exported by Seisen into the current deck (replaces current deck)

---

Setting Up A MySQL Database

Seisen uses a backup data method using MySQL, once Seisen is opened for the first time it will prompt for A database name and password, if you have these already feel free to enter these and Seisen will take care of the rest.

If not, you can always set this up latter in settings by typing 3 and then press 4.

---

License

This project (Seisen) is licensed under the GNU General Public License (GPL). You can find the full text of the license in the LICENSE file.

The GPL is a copyleft license that promotes the principles of open-source software. It ensures that any derivative works based on this project must also be distributed under the same GPL license. This license grants you the freedom to use, modify, and distribute the software.

Please note that this information is a brief summary of the GPL. For a detailed understanding of your rights and obligations under this license, please refer to the full license text.

---

Contact

If you have any questions, comments, or concerns, please feel free to contact me at [email protected].

For any bugs or suggestions please use this issues tab here.

---