Getting started

Add the phone to your game in about ten minutes. You only need to edit your script files.

Before you start

Check three things first:

• Ren'Py 8.2 or newer.
• The Pamyu Core folder: it comes in every Pamyu download.
• At least one character, defined with Character().

1. Copy the files

Unzip the download from itch.io. Copy the pamyu/ folder into your game/ folder. If you already own a Pamyu plugin, keep your core folder and only add phone/.

game/
  pamyu/
    core/   # shared by every Pamyu plugin
    phone/  # the Phone plugin
    pamyu_config.rpy
  script.rpy

2. Set your colours (optional)

Skip this step and you get Sorbet. Or set six colours in one small file.

# game/pamyu_config.rpy
define pamyu.paper  = "#fff8f0"
define pamyu.ink    = "#2f2a3f"
define pamyu.accent = "#a6e6d3"
# pop, alert, good…

3. Add a contact and send a message

Use the characters you already have. Each message is one line.

label start:
    $ phone.contacts(mara, flavour="soda")
    $ phone.messages(mara,
        "I missed the last ferry. Again.",
        "Can you wait for me at the pier?"
    )
    call screen phone_screen

4. Show the phone

One line opens the phone. The player reads, answers, and the story goes on.

$ call_screen phone_screen