← Jade & Ink Xianxia Ren'Py GUI Kit + 8 ink transitions

Jade & Ink Ren'Py GUI Kit

Quick Start Guide · xianxia GUI art + animated main menu + 8 ink brush transitions · Ren'Py 8 at 1920x1080

1. Install (1 minute)

  1. Back up your project's game/gui folder if you changed it, then copy the game folder from the zip over your project's game folder. It replaces the images Ren'Py already uses (text box, name box, frame, choice buttons, save slots, menus, bars, sliders...) with files of the same names.
  2. Open game/jadeink_colors_for_gui_rpy.txt and paste its color lines into your gui.rpy (replace the old lines with the same names).
  3. Animated main menu: in gui.rpy set define gui.main_menu_background = "jadeink_main_menu".

2. Use it without code

After step 1 the whole interface changes by itself: text box, name box, choice buttons, save and load slots, game menus, bars, sliders and scrollbars all use the jade-and-ink art, because the files keep the names Ren'Py already looks for. The main menu (step 3) shows a formation circle with two rings turning in opposite directions. The 8 transitions are ready to use by name in any script.

3. Use it from code

Ink brush transitions in your script

label start:
    scene bg pagoda night with ink_mist   # mountain mist, 1.6 s
    "The sect gates open at dawn."
    scene bg courtyard with ink_seal      # seal circle, 1.1 s
    "The elder is already waiting."

Animated main menu (gui.rpy)

define gui.main_menu_background = "jadeink_main_menu"

Jade colors (gui.rpy, from jadeink_colors_for_gui_rpy.txt)

define gui.accent_color = '#d9b65e'
define gui.idle_color = '#bfd8cc'
define gui.hover_color = '#f3dc98'
define gui.text_color = '#f0ead8'
# ...the file has all 10 color lines

Your own speed (any .rpy file)

define ink_mist_slow = ImageDissolve("gui/jadeink/transitions/06_mountain_mist.png", 3.0, 32)
# then: scene bg lake with ink_mist_slow

FAQ

Which transitions are included?

ink_bleed (1.2 s), ink_brush (1.0 s), ink_cloud (1.4 s), ink_blind - bamboo blind (1.0 s), ink_drops (1.3 s), ink_mist - mountain mist (1.6 s), ink_scroll - scroll unroll (1.0 s) and ink_seal - seal circle (1.1 s). Each one is an ImageDissolve with a mask: the white parts of the mask change first.

Which Ren'Py version and screen size?

Ren'Py 8 projects at 1920x1080, the default size of a new project.

Can I use the transition masks in another engine?

Yes. The masks are plain PNGs in game/gui/jadeink/transitions/ and work in any engine that supports mask or cutoff transitions.

Are there made-up Chinese characters in the art?

No. The circles use the real bagua trigrams and geometric shapes.

How do I go back to my old GUI?

Copy your backed-up gui folder back and restore your old color lines in gui.rpy.

Can I use it in a commercial game?

Yes. Use it in any personal or commercial game. Do not resell or redistribute the files as they are.

Get Jade & Ink Xianxia Ren'Py GUI Kit + 8 ink transitions ($8.99)