Getting started — Core 2.0

You are reading the Core 2.0 documentation. Core 2.0 is the current release. It unifies the plugin API and adds the PamyuScene context manager.

Before you start

Ren'Py 8.3 or newer — required for Core 2.0.
The Pamyu Core 2.0 folder from your itch.io download.
At least one character defined with Character().

1. Copy the files

Unzip the download and copy pamyu/ into game/. Upgrading from 1.x? See the upgrade guide.

game/
  pamyu/
    core/   # Pamyu Core 2.0
    phone/
    pamyu_config.rpy
  script.rpy

2. Configure your theme

Core 2.0 introduces theme blocks. The old per-variable style still works.

# game/pamyu_config.rpy  (Core 2.0 recommended style)
define pamyu.theme = PamyuTheme(
    bg     = "#fff8f0",
    fg     = "#2f2a3f",
    hi     = "#a6e6d3",
    pop    = "#f9a8d4",
    alert  = "#fca5a5",
    good   = "#86efac",
)

3. Add a contact and send messages

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. Use PamyuScene (new in 2.0)

PamyuScene is a Python context manager that queues contacts and messages before showing the phone, removing the need for bare $ lines.

label start:
    with PamyuScene() as scene:
        scene.contact(mara, flavour="soda")
        scene.message(mara, "I missed the last ferry. Again.")
        scene.message(mara, "Can you wait for me at the pier?")
    call screen phone_screen

5. Show the phone

call screen phone_screen