Phone reference
All functions and options for the Phone plugin.
Functions
phone.contact(character, flavour)
Register a character as a phone contact. Call this before the character sends any messages.
| Parameter | Type | Description |
|---|---|---|
| character | Character | A Ren'Py Character() object. |
| flavour | str | Colour name for the contact bubble. One of: soda, lilac, butter, peach, sky, berry. |
phone.message(character, text)
Add a message from a contact to the conversation history.
| Parameter | Type | Description |
|---|---|---|
| character | Character | The sending contact. Must be registered with phone.contact() first. |
| text | str | The message text. |
phone.typing(character, duration)
Show the typing indicator for a contact before a message.
| Parameter | Type | Description |
|---|---|---|
| character | Character | The contact who appears to be typing. |
| duration | float | Duration in seconds. |
phone.choices(options)
Show reply choices inside the phone and return the option the player picks.
| Parameter | Type | Description |
|---|---|---|
| options | liststr | One to four reply strings. |
Returns the chosen string.
phone.notify(character) — Full
Show a small notification bubble without opening the phone screen.
| Parameter | Type | Description |
|---|---|---|
| character | Character | The contact sending the notification. |
phone.photo(character, path) — Full
Send a photo inside a conversation.
| Parameter | Type | Description |
|---|---|---|
| character | Character | The sending contact. |
| path | str | Path to the image file, relative to game/. |
The phone screen
Open the phone interface from your script:
call screen phone_screen
Options
Set options once, in game/pamyu_config.rpy, using define pamyu.<option> = <value>.
| Option | Type | Default | Edition | What it does |
|---|---|---|---|---|
| flavour | str | "soda" | Lite and Full | Default frame colour for new contacts. |
| typing_speed | float | 1.0 | Lite and Full | Speed of the typing animation. 2.0 is twice as fast. |
| sound | str or None | "pamyu/phone/pop.ogg" | Lite and Full | Sound played when a new message arrives. None turns it off. |
| notify | bool | True | Full | Show a notification bubble when a message arrives and the phone is closed. |
| theme | str | "sorbet" | Full | Ready-made colour theme: sorbet, nightlight, or casebook. |
| max_history | int | 200 | Lite and Full | Maximum messages kept per contact. Older ones are removed first. |