Skip to content
XOYZ-Code edited this page Sep 30, 2023 · 7 revisions

Welcome to the Yoshida wiki!

Yoshida is a card creating software designed for giving users the most flexiblity with their designs. From different colors, fonts or sizes. With Yoshida you can do it all.

Disclaimer: Yoshida is not released as a version 1.0 which means there can be big changes to the way your layout is created. Especially the logic section needs some optimizations. If you find a bug or are in need a special feature do not hesitate to create a new issue to mention it.

Disclaimer: This wiki is still being worked on and is not yet up to date to the master branch.

Minimum Python Version

Setup

  1. Clone the repo or download the newest release from the release page.

    gh repo clone XOYZ69/Yoshida
    

    or

    git clone https://github.com/XOYZ69/Yoshida
    

    The newest release can be found here:

    Current Yoshida Version

  2. Create your own card design (wiki entries will follow) or use an exisiting one in the folder data/card_designs.

    Yoshida/
        data/
            card_designs/
                designs.json
    
  3. Add a new card set in data/card_sets for your card design or use an existing one.

    Yoshida/
        data/
            card_sets/
                set.json
    
  4. Edit the setup_example.py to include test_card_creation_basis(card_set = your_card_set, show = False)

    card_set is the name of your card set

    show is a boolean defining if you want to open your exported card instantly or only save it in the data/output folder.

  5. Call your function from the file and run it with python setup_example.py or simply call pytest -rA setup_example.py to run all tests.

    test_card_creation_basic(card_set = your_card_set, show = True)
    
  6. The finished images are created in the folder data/output/card_set

Configuration

The goal of Yoshida is to be highly configurable. If you want or need to change any settings have a look into the settings files. You can find them under data/settings/*.

The main configuration is the system.config.json. To get a clear view what all theese settings mean have a look here.

Clone this wiki locally