変更履歴 (Ren'Py 6.11 - 6.99) link

6.99.14.3 link

Changes link

The AlphaMask() displayable now places its mask inside the child displayable, in the same way that AlphaDissolve always has. This allows the mask to be created using ATL or other transforms.

Several obsolete image manipulators have been deprecated, and removed from the documentation. These are image manipulators that have been completely replaced by Transform().

Several functions have been renamed, to remove a pointless Live prefix.

LiveComposite is now Composite()
LiveCrop is now Crop()
LiveTile is now Tile()

The old names have been retained as compatibility alias.

Fixes link

This release fixes an issue where children of for statements in screens would not get their data propagated through screen update cycles. This manifested in complicated ways, such as transitions repeating and slow text refusing to work.

This release displays the newest save slot in the selected color, as intended. This applies to newly created games, older projects can update by adding to the bottom of gui.rpy:

define gui.slot_button_text_selected_idle_color = gui.selected_color
define gui.slot_button_text_selected_hover_color = gui.hover_color

A problem introduced in 6.99.14.2 with the default statement not working after a rollback has been fixed. This should only ever have affected games that were updated after a save was first created.

6.99.14.2 link

Features and Changes link

The Atom text editor is now supported in Ren'Py. When it is selected, Ren'Py will download Atom, and will create a new profile with the language-renpy, renpy-dark-syntax, and renpy-light-syntax Atom plugins installed, along with a few default setting to make Ren'Py programming easier.

It is now possible to supply a baseline to image-based fonts.

When a screen in the default gui scrolls, the pageup and pagedown keys will now work to scroll it. (This only works with newly-created projects.)

The Movie() displayable now takes a play_callback argument, which specifies a function that is called to play a movie. This function can do things like queue up a transition movie before queuing the usual loop, making for smooth transitions.

The new renpy.get_say_image_tag() function makes it possible to retrieve the name of the speaking character.

ATL interpolation can now interpolate from a transform with multiple lines in it, provided none of the lines takes time to complete.

Adding the from statement to a call no longer changes the translation identifier. (Which is also used by the automatic voice code.) Since this would be a breaking change, Ren'Py also computes the old-style translation identifier and uses that if it exists.

The _choose_attributes method is called when only a single displayable can be located. This supports the AttributeImage beta (https://github.com/renpy/ai).

The new gui.button_image_extension variable allows button images to be .webps without changing Ren'Py itself.

Self-Voicing link

Ren'Py's self-voicing mode, which provides accessibility for blind users, has been improved:

Selected buttons say the word "selected" after them.
Bars say the world "bar" after them.
Some actions have had their self-voicing information changed to better reflect how the action is used in the new GUI.
Alt text built into Ren'Py can be translated.

While this can change some of the self-voicing output, the changes should not affect any translations that already exist.

Fixes link

An issue where a save or auto-save could rarely cause data corruption in the non-saved game has been fixed.

Python hide statements are now run in a Python function context, which makes certain constructs (like generator expressions) compile and run correctly.

Global labels now behave as described in the documentation, even when indented.

A regression with custom mouse cursors that could cause the mouse to jump around wildly has been fixed.

An issue with side images persisting after a menu was shown has been fixed.

Ren'Py no longer stores the state of displayables that are not being shown in a screen that has been replaced. (This was an issue when the first screen is re-show, and the displayables took their old state.)

The show and replace events are now always delivered to a transform in a screen. While this behavior was always intended and could occur whenever a screen was shown, previously caching could prevent some show events from being delivered.

Characters that require the alt key can be typed. (The alt key is necessary to type particular characters in European languages.)

When the Android build system fails to rename a file or directory, it will retry for 60 seconds before giving up. This is an attempt to work around antivirus software breaking Windows semantics.

6.99.14.1 link

Image Prediction and Caching link

Ren'Py now searches for the bounding box of non-transparent pixels when converting an image into a texture. When the config.optimize_texture_bounds variable is true (as it is by default), only the non-transparent pixels are stored in the image cache. This can massively reduce the in-memory size of certain images, such as images that correspond to mostly-transparent layers.

The config.cache_surfaces variable is now False by default. This halves the amount of memory required for the image cache, but may slow down multiple image manipulators applied to the same image.

The size of the image cache is now controlled by the config.image_cache_size_mb variable, which defaults to 300 megabytes. With the new default settings, each pixel inside the images non-transparent bounding box takes up 4 bytes of memory.

The result of these three changes is that images take up less memory in cache, meaning Ren'Py can store far more predicted images.

Ren'Py now refuses to call functions that read from disk (such as renpy.image_size()) when predicting images and screens, rather than risking these slow calls leading to drops in framerate.

The ConditionSwitch() and ShowingSwitch() displayables have a new predict_all parameter. When True, this causes all displayables to be predicted, not just the currently selected one. This could be used to have Ren'Py preload all emotions of a sprite.

The renpy.start_predict() and renpy.stop_predict() functions now take wildcard patterns. For example:

$ renpy.start_predict("eileen *")

Starts predicting all images beginning with the tag eileen, while:

$ renpy.start_predict("* beach*")

matches all images that include a beach attribute.

The F4 key now displays the image load log.

Ren'Py 6.99.14 link

Performance link

Quite a bit of work has been done to improve performance, both absolute performance and apparent framerate stability.

When connected to a device with AC power, Ren'Py will attempt to draw the screen at a constant framerate. When the device is on battery, several frame will be drawn before reverting to the 5fps framerate, to ensure updates to the screen are pushed through display buffering.

Ren'Py has a number of options that control display performance, accessed through the Shift+G menu. In addition to the GL performance change described above, this allows the player to lock the framerate and accept tearing when a frame is late. A player on a slow machine might choose to prefer 30fps to an unstable framerate. If the developer expects many players will be on slow devices, a default can be chosen with:

default preferences.gl_framerate = 30

When a frame takes too long to render (say, because an unpredicted image has to be loaded from disk), Ren'Py will attempt to use the time the frame was presented as the base time for transitions and displayables. Effectively, this means that if Ren'Py has to skip frames, it'll skip them before the first frame in a sequence, rather than between the first and second frame.

Ren'Py itself triggers garbage collection immediately after a frame is drawn, if enough objects have been created. Outside of this collection, the number of objects required to trigger the garbage collector has been raised. The thresholds are high enough that collection should not be required if the game does not create circular object references. (That is, objects that refer to each other in a loop.) Ren'Py has been changed to eliminate common sources of circular object references.

For most games, Ren'Py managed garbage collection should reduce or even eliminate frame drops caused by the garbage collector. However, it is possible to revert to the previous tuning by setting config.manage_gc to False.

By default, Ren'Py will remove transient screens (like say and choice) and displayables without triggering on "hide" event handlers. The process of checking for such handlers was relatively expensive, while the use of those handlers is rare. This change can be reverted by setting config.zap_transients to False.

Ren'Py will now cache compiled Python expressions the first time it encounters them, rather than compiling an expression each time it is encountered. This speeds up the overused ConditionSwitch displayable, along with other parts of Ren'Py. Because of this change, a game will open slowly the first time it's run under Ren'Py 6.99.14, as all of the expressions need to be compiled.

This release both increases the speed of maintaining the information required by rollback, and does so less often. This may be visible to players by Ren'Py now allowing them to roll back farther than before.

There have also been many other performance improvements that will only be visible by the increased speed. This release just includes the first round of performance improvements, while a new performance profiling framework included will allow Ren'Py developers to further improve things.

Multiple Character Dialogue link

Ren'Py now includes a system that allows multiple characters to speak dialogue at the same time. It's accessed by giving the multiple argument to consecutive say statements. For example:

e "Ren'Py now supports multiple character dialogue." (multiple=2)
l "About time! I've been wanting this for years!" (multiple=2)

As there is more than one way to show dialogue from multiple characters (side-by-side? top-and-bottom? one or two textboxes?), Ren'Py doesn't include support for this out of the box yet. Please see the 複数キャラクターダイアログ section of the documentation for the styles you'll need to define.

GUI Preferences link

Ren'Py supports a new GUI preference system that replaces the old style preference system, as it allows preferences to apply to variables in the new GUI that can be referenced from multiple styles.

This makes it possible to write:

define gui.text_font = gui.preference("font", "DejaVuSans.ttf")

To access the preference, and:

vbox:
    style_prefix "radio"
    label _("Font")
    textbutton _("DejaVu") action gui.SetPreference("font", "DejaVuSans.ttf")
    textbutton _("Dyslexic") action gui.SetPreference("font", "OpenDyslexic-Regular.otf")

to set it. See the section on GUI Preferences for more details.

Tooltips link

A new tooltip system has been added to Ren'Py, to replaced the one that already existed. While in the previous system, one had to write:

default tt = Tooltip("No button selected.")

textbutton "One.":
    action Return(1)
    hovered tt.Action("The loneliest number.")

text tt.value

It's now possible to write:

textbutton "One.":
    action Return(1)
    tooltip "The loneliest number."

text GetTooltip()

This is intended to save boilerplate and make screens more readable. For more information, see the Tooltip section.

Changes link

SSL and TLS support has been added to all platforms. This allows Ren'Py games to make requests to secure web servers, perhaps in conjunction with a Python library such as requests. This support is only included in built distributions if imported at init time.

The new im.Data() image manipulator creates an image from compressed binary data, as might be downloaded from a web server.

The config.loadable_callback lets scripts inform Ren'Py about additional loadable files.

Ren'Py will attempt to diagnose problems with pickling objects during a save, and report an object that caused a pickling problem. (This is best-effort, but tends to catch common problems.)

When a viewport is given scrollbars, Ren'Py will now offer its child a large amount of space in the given direction. This prevents problems with displayables drawn at or below the visible area of a viewport.

Ren'Py now resolves the ambiguity between the xpos and xalign style properties in favor of xpos, and similarly for other cases where both more and less specific style properties are given to the same style.

Custom statements now take a label function that can return a custom label for the statement. This allows the custom statements to be jumped to or called.

The new config.gl_clear_color variable allows a creator to set the color of the letterboxes and pillarboxes used when the screen is not filled.

Drag displayables (part of the drag and drop system) now support a bottom method, that can be used to lower the drag to the bottom of its drg group.

The config.cache_surfaces variable, added in the last release, has been documented. Setting this variable to False can reduce Ren'Py's memory consumption, at the cost of of slowing down images used by multiple image manipulators. (Which should be a rare case in modern Ren'Py.)

Variable and field munging (which change the name of a variable that begins with __ to a file-specific value) now work inside string substitutions.

Viewports and vpgrids now support the pagekeys property, which allows one to use the pageup and pagedown keys to scroll the viewport. The arrowkeys property is now documented.

RAPT now compiles Java code using a source and target version of 1.6, which allows it to be built on modern JDKs.

Fixes link

An issue where screens could display incorrectly when compiled at different times has been fixed. This could only show up under certain circumstances.

The project has screens in multiple files.
The files were compiled at different times. (This can never be the case for a released game, since all files are recompiled at the same time when building distributions.)

After upgrading to this release, the problem can be fixed by pressing "Force Recompile" in the launcher. This can be done for any game in development, but isn't necessary for released games.

There have been several improvements to the interactive director, allowing it to work in more circumstances.

A race condition that could cause Ren'Py to lock up (causing a blank screen to be displayed) on Android and iOS has been fixed. This was introduced in 6.99.13.

In 6.99.13, a race condition caused Ren'Py to infrequently skip movie playback entirely.

Ren'Py now supports the AltGr key.

Ren'Py now limits the amount of console output it logs, to prevent print statements from consuming memory if the console is never displayed.

Ren'Py 6.99.13 link

Tutorial and The Question link

This release includes updated versions of the Tutorial game and "The Question", the example game that's bundled with Ren'Py.

The Tutorial game has been largely rewritten, and is now structured as a pair lectures, the first covering the creation of a basic visual novel in Ren'Py, and the second covering in-depth topics needed to create more advanced games. The Tutorial has also lost content that is less relevant to modern Ren'Py, focusing in on the features that are the best practice to use in new games.

The Tutorial now has over 250 examples, that can now be copied out of the tutorial and into your own projects.

"The Question" has been rewritten with a new script by Lore, one that is more appropriate for educational use than the original. It's also been updated with new background, and to demonstrate best practices when writing Ren'Py scripts.

Both games have been modernized with high-definition widescreen graphics and use of the new default Ren'Py GUI.

Right now, the old tutorial is still distributed with Ren'Py, and is used if when a translation is present for the old tutorial but not the new tutorial.

Interactive Director link

Ren'Py now ships with an built in interactive director tool. This tool makes it possible to add the scene, show, hide, with, play, queue, stop, and voice statements to Ren'Py from inside an under-development visual novel, without having to change to a text editor and reload the project. The interactive director can be accessed by pressing the D key (without Shift) inside an unreleased game.

The interactive director had been distributed outside of Ren'Py, with a license that made it free for noncommercial use. It's now part of Ren'Py, and has the same license as the rest of Ren'Py, which allows for both commercial and noncommercial use.

New GUI link

A few changes have been made to the new GUI. Buttons have been brightened and their text shrunk. Bars have been reduced in height somewhat. The intent is to provide more room in menus, especially for game-specific preferences on the preferences screen.

For newly-generated games, it is now possible to customize the location and look of the namebox (the frame containing a character's name) on a character by character basis. This is done by giving properties prefixed with namebox to the Character. For example, the namebox_background property changes the background of a namebox.

Raspberry Pi link

Ren'Py now comes with experimental support for the Raspberry Pi platform.

The Raspberry Pi port is similar to the Android and iOS ports, both in its limitations and how it's meant to run games rather than develop them. As with all platforms, creators developing for the Raspberry Pi need to account for the resources available to them and design their games accordingly.

That being said, The Question and the new Tutorial both run on a Raspberry Pi 3 computer costing $35.

Hyperlinks link

Hyperlinks created with the {a} text tag now support jumping and calling labels. A tag of the form {a=jump:label} jumps to the label, while one of the form {a=call:label} ends the current statement and calls a label. There are also {a=show:screen} and {a=showmenu:screen}, which show screens in-game and in a menu context, respectively.

The new config.hyperlink_protocol variable determines the default protocol for a hyperlink that has none. For example, if it's "jump", then {a=mylabel} is equivalent to {a=jump:mylabel}.

The new config.hyperlink_handlers variable is a dictionary mapping protocols to functions, which can be used to add creator-defined protocol handlers.

The size of a hyperlink is now inherited from the size of the enclosing text. This makes hyperlinks work within text of a non-default size.

Say with Arguments link

The Ren'Py say statement now supports being passed arguments, which are placed in parenthesis after the text to be spoken. For example:

e "Hey!" (what_size=36, what_color="#ffeeee")

These arguments are first passed to config.say_argument_callback, and then are passed to the character. The default implemention (in Character()) creates a new character with the passed arguments, and uses that to display the text.

One place this is handy is with jump hyperlinks and the new advance argument to Character, which prevents text from being advanced directly. It's now possible to write:

e "Would you like to go {a=jump:living_room}west{/a} or {a=jump:kitchen}north{/a}?" (advance=False)

Which pauses execution until the player clicks on a hyperlink.

Translations link

The launcher and default project have been translated into French, courtesy of Alexandre Tranchant.

The launcher and default project have been translated into Brazilian Portugese, courtesy of MrStalker.

The Indonesian and Simplified Chinese translations have been updated.

Ren'Py 6.99.12.4 link

Console link

The Ren'Py console has been updated to match the neutral Ren'Py style, and to add a number of new features:

The console is now available during exception handling. (As always, it accesses the global scope.)
The console history is kept as part of persistent data.
Watched variables are stored as part of save files, which means that the watch is restored when the game is (automatically or manually) reloaded.

Ren'Py 6.99.12.3 link

GUI link

It is now possible to systematically customize the look of different kinds of text in Ren'Py. For example, one can now choose different sizes for name, dialogue, interface, label and prompt text.

All text properties are now available through the gui system. For example, gui.text_outlines can be used to make text outlined by default, while gui.name_text_bold can be used to make character names bold.

To allow for the above two changes, some of the gui variable names have been renamed in a more systematic manner. For example, gui.default_font has been renamed gui.text_font, while gui.name_font has become gui.name_text_font.

It is now possible to outline gui text using variables like gui.text_outlines and gui.interface_text_outlines.

Due to the design of the new GUI, the changes described in this section will only take effect when a new game is created, or a game's GUI is updated.

Translations link

The Russian translation has been updated and modernized, thanks to Ria-kon and Project Gardares.

The Italian translation has been updated and modernized, thanks to Gas.

Ren'Py 6.99.12 link

Macintosh Support link

This release includes a number of changes to support macOS Sierra. These include:

The Macintosh application produced by Ren'Py is now read-only by default. Save files will be placed in a system-global directory, while screenshots will be written to the Desktop.
The organization of the Mac application has been changed to allow the application to be code-signed.
When run on a Macintosh with Xcode installed and the build.mac_identity variable set properly, Ren'Py will use the codesign tool to sign the package before archiving it.
When run on a Macintosh, Ren'Py will create a .dmg file containing the application. When Xcode is installed and build.mac_identity is set, the package will be signed.

The result of this is that, when a creator has a Macintosh computer and a (free) Developer ID Application certificate, it is possible to create distribute downloadable Ren'Py games that satisfy Gatekeeper and Gatekeeper Path Randomization.

Since it is no longer possible to make a single distribution that runs on all desktop platforms, the all (Windows, Mac, and Linux) package type has been removed. It's been replace with a pc package type that supports Windows and Linux, and the existing mac type that supports macOS. (There is a new steam package type to help with app store bundles, but that's not recommended for distribution to end users, since it won't work with macOS Sierra.)

The launcher has been modified so it can launch games created using older versions of Ren'Py, even under Sierra. This can be done by placing the game inside the Ren'Py directory, starting Ren'Py, choosing the game in the launcher, and choosing "Launch Project".

Translation Changes link

Support generating projects in non-English languages has been improved. When a new project is created, it includes translations of the interface strings into the project's language, allowing the translation of text presented to the player by Ren'Py.

There is now a single place for translating Ren'Py – translating the launcher also now translates the comments of a generated game. The process of translating Ren'Py (the launcher and the GUI) is now documented on the Translating Ren'py page. This page also suggests a logical order in which strings should be translated.

Functions have been added for selecting an alternate font, changing defines (such a text size), and copying files into a generated project, based on the translation.

Translate python blocks are now executed before regular style statements (translate style statements are executed after both). This change was intended for and documented 6.99.11, but the implementation was flawed, so a corrected implementation is used now.

Python Changes link

Ren'Py will now compile Python code as if:

from __future__ import absolute_imports, print_function, unicode_literals

was true. If compilation fails, it will then re-compile the code without these settings. This is intended to allow new code to be written that will be compatible with a future Python 3-based Ren'Py.

This should have minimal impact to existing code. The one case where it could be a problem is if a character string is used to encode binary data, in which case a binary string (b"string") should be explictly used.

Ren'Py 6.99.11 link

New In-Game GUI link

Ren'Py ships with a new default GUI. This system, used in-game to customize the main menu, game menu, and in-game screens, replaces the old themes and screens.rpy system with a new system that's intended to be an improvement for every creator:

For new creators, the new GUI is intended to look attractive (if generic) out of the box. It is adaptable to a choice of sizes, and supports games with light and dark backgrounds.
Intermediate creators will be able to more easily customize the new GUI, without having to to work with screens and styles directly. It's now possible to completely re-theme the GUI by changing variables in the gui namespace, and editing template images.
Advanced creators will be able to replace the new gui entirely, either piece by piece or wholesale. The new gui infrastructure resets all styles to sensible defaults, making it easier to apply customization.

There is also a gui customization guide, consisting of over 5,000 words of documentation and code, and 40 images, that explains how to change the look of the GUI.

In addition, the new GUI adds support for a number of new features. These features are generally implemented in a way that custom GUIs can take advantage of. Highlights include:

The GUI defaults to supporting 16:9 widescreen resolutions.
The new GUI is intended to support PCs and mobile devices in landscape mode. Where appropriate, it conforms to iOS and Android interface guidelines.
The new GUI includes native support for a history or readback screen.
The new GUI includes support for assigning names to file pages, allowing a certain amount of organization to be applied to files.
The NVL and choice screens are now given lists of objects as parameters, instead of tuples. (The objects also function as tuples, for compatibility with old code.)
The yesno_prompt screen has been renamed to confirm.
Ren'Py supports the use of a ctc screen to display the click-to-continue indicator.

Improved Platform Support link

There have been a number of fixes to Ren'Py's support for various platforms.

Windows HighDPI mode is detected properly when displaying the presplash.

Android The Android build system has undergone a rewrite, adding support for x86, while retaining and modernizing support for ARM devices. RAPT now included many dependencies, fixing Android build problems.

Ren'Py now supports immersive mode on Android's 4.4+. Immersive mode hides the system UI, including the navigation bar, allowing Ren'Py to take up the entire screen.

Chrome OS Ren'Py now support ChromeOS by running the Android APKs via the Android Runtime for Chrome tool.

Style Prefix Support link

Ren'Py now supports the use of a prefix_ substitution with style properties. Where previously, one was required to write:

style button:
    insensitive_background "insensitive_button.png"
    idle_background "idle_button.png"
    hover_background "hover_button.png"
    selected_idle_background "selected_idle_button.png"
    selected_hover_background "selected_hover_button.png"

one can now write:

style button:
    background "[prefix_]button.png"

This searches through prefixes in a manner similar to the way styles do. When looking for a selected_idle_background, Ren'Py will search for selected_idle_background.png, idle_background.png, and background.png

Style Properties link

Windows and buttons can take the padding and margin style properties. These properties can take a tuple that gives the margin and padding on all four sides.

The new base_bar style property sets the left and right (or top and bottom) bars to the same value. It can be to set the background of a slider or scrollbar the uses a thumb image.

The xfit and yfit style properties can be given to the fixed screen language statement and Fixed() displayable. When a fit property is true, the fixed shrinks in the given axis to fit all child displayables.

Buttons and Windows now fully respect the xmaximum and ymaximum style properties.

There is now a offset style property, which sets the xoffset and yoffset properties to the first and second components of a tuple.

Translate and Style Statement Order Changes link

The config.defer_styles variable has been added to determine if style execution should be deferred, as described below. If config.defer_styles is true when style evaluation would have occurred, that style is put on a deferred list. The gui.init() function called by the new GUI sets this variable to true.

To facilitate translations customizing the fonts of the new GUI, the order of execution of translate python, style and translate style statements has been changed. When the game starts (after all statements have run), or when the language changes, the following steps occur.

The gui named store is cleaned to its state at the end if init. (This is the store that all variables defined with gui.`name` live in.)
All translate language python statements are run, where language is the current language.
All deferred style statements are run.
All translate language style statement are run, where language is the current language. (If not None.)
The callbacks in config.change_language_callbacks are called.

Ren'Py can be made to return to the old behavior (in which only translate language style, translate language python, and callbacks are executed) by setting config.new_translate_order to False.

Local Labels link

Ren'Py now supports labels scoped to inside another label. It's possible to write:

label day1:

    menu:
        "Should I sleep in?"

        "Yes":
            jump .afternoon

        "No":
            jump .morning

label .morning:

    "It's the morning."

label .afternoon:

    "It's the afternoon."

In this code, the .morning and .afternoon labels can be jumped to directly from code that is immediately after the day1 label, or by jumping to day1.morning or day1.afternoon from other code.

Transforms link

Transforms now support xtile and ytile transform properties. These properties allow the underlying displayable to be tiled multiple times.

Transforms now support xpan and ypan transform properties. These properties take an angle (between 0 and 360 degrees, but angles outside that are clamped to that range). The angle is used to pan the image horizontally or vertically by that amount. This makes it possible to simulate a 360 degree panoramic image.

Translations link

When generating a new project, all of the strings in the new game are translated using translations taken from the launcher project.

A Vietnamese translation of the launcher and tutorial have been added to Ren'Py. Thanks to Thuong Nguyen Huu for contributing it.

A Indonesian translation of the launcher and default project has been added to Ren'Py. Thanks to Pratomo Asta Nugraha for contributing it.

Ren'Py can now automatically generate a piglatin translation for test purposes.

Ren'Py 6.99.10 link

Fixes link

This release contains multiple fixes to regressions that affected some, but not all, players and creators. Upgrading from Ren'Py 6.99.9 is strongly recommended.

Problems opening a DirectInput gamepad or joystick in exclusive mode could prevent Ren'Py from starting.
A failure to preload a library prevented Ren'Py from starting on some Android devices.

Translation link

This release features a new Greek translation of the launcher, contributed by George Economidis.

Ren'Py 6.99.9 link

Ren'Py's audio and movie playback support has been completely rewritten, allowing for the addition of many features that would not have been possible without this rewrite. These include:

Partial playback of audio files, using a concise notation. This allows the creator to specify start and end points, and a loop point at which playback continues on the second and later iterations. A similar notation can be used to queue silence.
A new default channel named audio has been added. Unlike the sound channel, the audio channel supports playing back multiple audio files simultaneously (limited by system performance).
The new PauseAudio() action can pause and unpause audio playback as required.
The new renpy.music.get_pos() and renpy.music.get_duration() functions return the curent playback position and total duration of an audio channel, respectively. AudioPositionValue() can be used to display these as the value of an animated bar.
Movie playback now supports playing multiple movies at the same time, provided all movies share the same framreate, and limited by system performance.
Movies now loop seamlessly at the end of playback.
Ren'Py now supports movie sprites, which are sprites backed by two movies, one containing color information and the other containing the alpha channel. Movie sprites are a superior alternative to animated gifs, as modern movie formats provided greater color depth and far superior compression. Movie sprites are supported on all platforms, including mobile platforms, subject to system performance.
Movies are no longer required to contain an audio track for synchonization.
It is now possible to play back a movie file on an audio channel, in which case only the audio track is played.

The play and queue statements now evaluate filename expressions in the audio namespace, which makes it possible to alias a short name to an audio file.

The default audio sample rate has been increased to 48 kilohertz, which should produce a slight increase in audio quality.

Audio and movie playback support now uses ffmpeg 3.0, and support for the VP9 video and Opus audio codecs has been added to the default distributions. The Opus codec can automatically adjust to speech and music, and should be considered by all creators.

Bug Fixes link

A bug has been fixed that caused fullscreen windows to be displayed at the wrong side on the Microsoft Windows platform when system-wide DPI scaling is enabled.

The Drag.snap animation has been fixed.

Ren'Py 6.99.8 link

Tags, Layers, and Transforms link

The new config.tag_layer variable makes it possible to specify the default layer used by an image on a per image tag basis. This makes it possible to place an image on its own layer without having to use onlayer. The new config.default_tag_layer variable specifies the default layer for unknown tags.

The new renpy.add_layer() function provides as way to add a new layer above or below the existing layers, if and only if the layer does not already exist.

The new config.tag_transform variable makes it possible to specify a default transform (or list of transforms) to use when a transform is not provided as part of a show or scene statement.

The new config.tag_zorder makes it possible to specify a default zorder that's used for a tag when no other zorder is used.

Easing Functions link

Thanks to Nyaatrap, Ren'Py now supports Robert Penner's easing functions in ATL. These functions speed up and slow down interpolations (and in some cases, can cause interpolations to overshoot their targets), in order to provide more pleasing and natural motion.

The new easing functions are documented in the ワーパー section.

Side Images link

New-style side image functionality (using images with the side tag) has been overhauled. It's now possible to apply an ATL transform, and hence a transition, whenever the side image changes. Different transforms can be used in the case where the character changes and the case where it stays the same.

See the サイドイメージ section for complete documentation.

PushMove Transitions link

A new type of transition - PushMove() - has been added to Ren'Py, along with the pushright (or pushleft, pushtop, pushbottom)

Ren'Py 6.99.7 link

Dynamic Images link

Dynamic images have been added to Ren'Py. It's now possible to write code like:

image eileen happy = "eileen [outfit] happy"

This code creates a displayable that interpolates the value of the output variable at least once per interaction. The interpolated string is then used to find another displayable to use.

Dynamic images can be used anywhere a displayable is expected, and the string can be an string that resolves to a displayable. One possible use might be to replace boring and repetitive condition switches in dress-up games with code like:

image eileen dressup = LiveComposite(
    (300, 600),
    (0, 0), "eileen_base.png",
    (0, 0), "eileen_top_[top].png",
    (0, 0), "eileen_bottom_[bottom].png",
    (0, 0), "eileen_accessory_[accessory].png",
    )

Dynamic image can be used in a screen language add statement:

for item in inventory:
    add "store_[item].png"

When so used, the variables are looked up in both the screen and global scopes.

Define Improvements link

The define statement can now be used to define config and persistent variables. The code:

define config.screen_width = 1280
define config.screen_height = 720

Now works as expected. Persistent variables work in an idiosyncratic way, as the code:

define persistent.unlocked_endings = [ ]

Will only set the unlocked_endings variable if it has not already been set.

Android/iOS link

The android SELECT key – present on remote controls – is now supported for advancing text and selecting buttons, bars, etc. This means most TV-based android consoles should be supported.

Direct support for the OUYA console has been dropped. The console should still be supported as a general TV-based android console.

The new config.save_on_mobile_background and config.quit_on_mobile_background make it possible to adopt various strategies to deal with an Android or iOS app losing focus.

To help apps comply with an Apple policy on the purchase of money cheats, consumable in-app purchases have been added for iOS only.

Ren'Py 6.99.6 link

HighDPI/Retina link

Support for HighDPI/Retina displays has been added to Ren'Py. This support is automatically used when running on iOS or Mac OS X systems that have a retina display.

On all platforms, Ren'Py now renders text at the display resolution, rather than the resolution the game was set to. The result is that text remains sharp even when upscaled significantly. Creators should be aware that due to variability in character size and kerning, this can cause changes in text layout and word wrap as the window is scaled.

To get the greatest benefit from these changes, the included copy of DejaVuSans has been updated to version 2.35, and the DejaVuSans-Bold font has been added. The bold font will automatically be used when a bold version of DejaVuSans.ttf is requested.

Gamepad link

Ren'Py now uses the SDL2 controller API to support gamepads. This API provides a standardized mapping of controller buttons to something similar to an Xbox controller.

Backups link

Ren'Py will now automatically back up .rpy files that are part of changed games. These backups will be placed in the same system-specific location that save files are placed.

Ren'Py 6.99.5 link

Startup link

Much work has been done to reduce Ren'Py's startup time, especially on mobile platforms such as Android and iOS. This was largely accomplished by caching the results of transforms, analyses, and code compilation so less work is done when the game is unchanged. To take full advantage of this, perform a 'Full Recompile' of your project from the front screen of the Ren'Py launcher.

The desktop presplash code has been rewritten to use pygame_sdl2, and is now also faster.

A new config.minimum_presplash_time has been added. This ensures that the desktop presplash, android presplash, and iOS launchscreen are displayed for at least a certain amount of time, making them more useful for branding purposes.

As part of this work, script_version.rpy and script_version.rpyc will no longer be added to packages. Instead, script_version.txt will be added. (This ensures that the script does not change as part of packaging.) In addition, bytecode.rpyb has been moved to the game/cache directory, where addditional cache files now join it.

iOS link

There have been a number of improvements to renios, some necessary to get Ren'Py games accepted on the Apple App Store. Nightly builds of 6.99.5 have been used to get multiple games accepted.

Renios has been upgraded to use SDL 2.0.4 rc1. This improves compatibility with iOS 8, and makes it possible to keep the launchscreen displayed until Ren'Py fully starts. As a result, support for the ios-presplash image is no longer necessary, and has been dropped.

Ren'Py 6.99.4 link

The Ren'Py script language now includes a new default statement. This statement sets a variable to a value a default value at game start or load, if a default statement has not set the value of the variable in the current game. This makes it possible to initialize saved variables near the relevant code, rather than all at once at label start.

Lint will now warn if a define or default statement redefines a Ren'Py or Python built-in name.

The screen language use statement now takes a block, which can be transcluded into a screen using the transclude statement. This makes it possible to use statements to "wrap" a block of screen language code.

The screen language also supports creator-defined statements, which are transformed into use statements. These make it possible to extend the screen language syntax.

The new Render.place() is available for use in creator-defined displayables. This method renders a displayable, then applies Ren'Py's layout algorthing to place that displayable within a containing rectangle.

Ren'Py now logs errors importing the steam module to log.txt.

Ren'Py now logs the duration of various parts of the init process to log.txt.

On mobile, Ren'Py will wait until the start of the first interaction before creating the main window. This prevents a black screen from being displayed for some time as Ren'Py starts.

There are a number of improvements to iOS support, to support passing Apple's package verification process.

The launcher now includes a button to retrieve logcat information from an Android device.

The launcher now checks that the version of rapt and renios match the version of Ren'Py proper.

Fixes link

Fixed a performance problem caused by failing to release the Global Interpreter Lock while waiting for event input. This could cause problems running various background threads, like the image preloader and autosave.

Ensured that screens are only analyzed once as the game starts. Previously, screens could be analyzed multiple times as the styles and languages were set, leading to excessive startup times, especially on mobile platforms.

The volume curve has been changed to be more correct and perceptually accurate. The previous curve had serveral problems, most notably that is sharply jumped from 0 to 10%. This may require players to adjust their volume settings.

The gallery slideshow timer now repeats through multiple images.

Text blits are now expanded to include an outline on a descender on the bottom row of text.

Drags outside of a draggroup can now be snapped into place.

The Gallery now properly advances through locked and unlocked images. Previously, this advancing was reversed, so next_unlocked would advance through locked and unlocked images.

Text accounts for the size of outlines when allocating textures, preventing the bottom line of outlines from being cut off.

Position information (xpos, ypos, etc.) are now passed from an inner transform to an outer transform during as single frame. Previously, this information would lag by a single frame, which could lead to nested transforms lagging or failing to complete.

Ren'Py 6.99.3 link

Removed debugging code that could cause problems by writing an unnecessary zipfile.txt file.

Ren'Py 6.99.2 link

Ren'Py now supports an images directory underneath the game directory. Images found inside this directory – or in subdirectories of this directory – will be automatically defined as images in Ren'Py. This will likely render the use of the image statement obsolete in simple games.

The new AlphaMask() displayable allows one displayable to be masked by the alpha channel of another.

The android and iOS emulators now emulate the onscreen keyboard.

The achievement API has been changed somewhat, but only with respect for progress functions. (Which were broken in the previous releases.)

Actions that care about the current screen (like SetScreenVariable) now work when used with the hovered and unhovered properties.

The updater has improved. If an incremental download fails, Ren'Py will try downloading the complete file before giving up.

When building for Android, Ren'Py will copy the apk files in to the dists directory used by the desktop platforms.

Added the RestartStatement() action.

Added the renpy.reset_physical_size() and ui.screen_id() functions.

Allowed the screen language key statement to take the activate_sound style property. This makes it easier to play a sound when a key is pressed.

Documented ui.interact().

Updated the Simplified Chinese and Korean translations, and the Italian template.

Ren'Py 6.99.1 link

Added the renpy.load_image(), renpy.load_surface(), and renpy.get_showing_tags() functions.

Ren'Py 6.99 link

SDL2 link

Ren'Py is now based on Pygame_SDL2, a reimplementation of the Pygame API based on the SDL2 library. One of the largest changes in Ren'Py's history, switching to SDL2 lays the groundwork for many improvements, in this and future releases.

iOS Support link

Ren'Py now supports the iOS platform. To develop for iOS, you will need a Macintosh computer, Xcode, and a paid membership in the iOS developer program. (An iPad or iPhone to test with is highly recommended.)

Ren'Py's iOS support includes the ability to create Xcode projects, and to update those projects with the latest version of a Ren'Py game. Xcode can be used to change project settings, and to create debug and release builds.

The iOS port supports iOS 7 and higher. Almost all of Ren'Py is supported, with the exception being that video playback is limited to fullscreen video in formats the iOS device supports.

For now, the default set of Ren'Py screens are not particularly compatible with iOS. You will need to customize your game to make it touch friendly and compliant with Apple's guidelines before submitting it to the iOS app store.

Please see the iOS documentation for more information and a copyright notice you must include as part of your app description on iOS.

Android Support link

Android support has been rewritten, and is now based in SDL2. This release brings Android support to parity with desktop platforms. Improvements include:

Support for rotating the screen to match the user's preferred orientation.
Improved in-app purchase support, with the ability to retrieve prices and create a single .apk that supports the Google and Amazon stores.
Android audio playback is now based on the same code that's used on the desktop and iOS platforms. This enables support for features like panning and fading volume. It also means the same sound files can be used on Android, iOS, and desktop platforms.
Keyboard input is now supported on Android.
Languages requiring bidirectional text (like Arabic and Hebrew) are supported on Android.

A number of issues with Android support have been fixed, including one that prevented Ren'Py from unzipping the android SDK automatically when the path to the Ren'Py install was too long.

Please see the Android documentation for more information and a copyright notice that should be included as part of your app description.

Steam link

Ren'Py now ships with Python bindings for the steam API. These bindings are built as part of the Ren'Py build process, which means they will be maintained alongside Ren'Py going forwards.

For an explanation of how to use the Steam API, please contact the Ren'Py developers directly. The bindings make available:

Initialization.
User statistics and achievements.
Retrieving other apps by the same developer that have been installed.
DLC support.
The in-game overlay, including the ability to launch a purchase flow.
Session tickets.

The steam bindings will be integrated with Ren'Py as appropriate. For now, this integration consists of binding the steam achievement system to the new Ren'Py achievement API.

Distribution Improvements link

The launcher now has the ability to add from clauses to call statements, automatically turning:

call dayplanner

into:

call dayplanner from __call_dayplanner

From clauses, which are really labels, help Ren'Py to find the return site to use when a game is changed. This should help fix problem with games that may change greatly between releases.

When asked to package a game that is more than about 2GB in size, Ren'Py will produce a ZIP64-format archive. These archives may be less compatible that smaller zip files.

Languages and Translations link

There is now a Russian translation of the tutorial game, and a Finnish translation of the launcher.

Ren'Py supports input methods (IMEs) on platforms where SDL2 makes that support available. (All platforms except for Linux.) Input methods make it possible to input complex non-ASCII text, such as Chinese, Japanese, and Korean.

Clipboard Voicing link

Ren'Py now supports clipboard voicing, which is accessed by Shift+C.

Clipboard voicing is a form of self-voicing that works by copying the text to the clipboard, where a screenreader program is likely to read it using settings preferred by the player.

Custom Text Tags link

Ren'Py snow supports a new form of custom text tags.

Custom text tags are applied after the text has been tokenized into tags and text. This makes it easier to write a custom text tag that manipulates text or applies multiple existing text tags to text.

The previously-existing form of custom text tag has been renamed to style text tag, and is still supported.

Ren'Py 6.18.3 link

This release adds the showif statement to screen language. The showif statement shows and hides its children based on a condition. When its children are ATL transforms, showif delivers ATL events to manage the show and hide process.

Ren'Py's image prediction mechanism now models the return stack, and can predict images through a call and return pair. Previously, a call followed by a return would block image prediction.

Ren'Py now predicts that the start label will be called from the main menu. This will help to avoid unpredicted image loads at the very start of a game.

The ATL on statement now can take a comma-separated list of event names.

The new updater.UpdateVersion() function contacts an update server and determines if an update is available.

The new renpy.invoke_in_thread() function runs a function in a background thread, and restarts the interaction when that thread finishes.

While in self-voicing mode, the {w} and {p} tags are ignored.

The Traditional Chinese and Russian translations have been updated.

Bug Fixes link

Fixed a regression that could cause hiding transforms to skip time.

Fixed a bug that would cause the screen language if statement to show children from blocks with a false condition, if those child blocks were run during prediction.

Fixed an issue where SetScreenVariable and ToggleScreenVariable were declared as pure functions, but weren't. They now have been reimplemented as pure functions.

Fixed an issue where a grab could fail to transfer between interactions, leaving Ren'Py unresponsive.

Ren'Py 6.18.2 link

The define statement can now take a store name, and the say statement will search the character store before searching the default store. This means that if one uses:

define character.e = Character("Eileen")

Say statements like:

e "Hello, world."

will continue to work, even though e has been freed up for other purposes.

The default image cache size (set in config.image_cache_size) has been increased from 8 to 16 screens worth of images.

When set to True, the new crop_relative transform property tells a Transform to interpret float components of its crop property relative to the width or height of its transformed child, as appropriate. For example, (0.5, 0.0, 0.5, 1.0) will cropout the lower-right quadrant of the child.

When set to false, the new keyboard_focus style property hides buttons, bars, and imagemap hotspots from the keyboard focus mechanism.

The Mousearea screen language statement now respects the focus_mask style property, making it possible to have non-rectangular mouseareas.

Ren'Py now includes functions that can be used to profile the memory consumption of a game, including the memory consumption of Ren'Py itself. These functions are renpy.profile_memory() and renpy.diff_memory(). The new renpy.profile_rollback() lets one more specifically see the memory consumption of the internal rollback log.

When self-voicing mode is enabled, Ren'Py displays a notification that explains how to disable self-voicing mode.

This release fixes a subtle bug caused by incorrect analysis of for loops in screen language screens, when the iteration variable is a constant. (For example, when the iteration variable is defineed somewhere else in the game.)

This release adds Traditional Chinese translations of the launcher and template game, contributed by Civalin.

Ren'Py 6.18.1 link

This release includes a new Placeholder() displayable, which can be used to display placeholder characters. Placeholders are now used when displaying images that are not defined.

The new sv Character-like object can be used when self-voicing is enabled to display (and hence speak) descriptive text.

ATL transforms in screens now begin executing when first shown. Previously, ATL transforms began executing when the screen containing the ATL transform was first shown, which meant that if the transform changed over the course of screen display, a portion of the new transform would be skipped.

This release includes a German template contributed by NoJoker.

Ren'Py 6.18 link

Screen Language Improvements link

This release includes a new implementation of screen language that has the potential to be much faster than the original implementation of screen language. Where the original screen language evaluated screens from scratch at the start of each interaction, this new implementation can incrementally reuse large portions of a screen between interactions. Please see the new Screen Language Optimization documentation for information on how to maximize screen language performance.

Of special note is that screens now perform better when defined with a parameter list. Screens that do not expect parameters should be defined with an empty parameter list.

To support improved optimization, when the screen language use statement calls a screen with a parameter list, only variables in that parameter list are updated. (This is a change in previously-undocumented behavior.)

Screens now support passing properties to a displayable from within an if statement, provided the if statement is the first thing inside the displayable. For example:

text "Eileen":
     if eileen_mad:
         color "#fcc"
     else:
         color "#cfc"

now works.

As there is now a larger benefit from predicting screens, screen prediction has been improved in several ways:

By default, Ren'Py will now use the arguments supplied to a screen in the show screen and call screen statements to predict the screen. This is potentially dangers, as it means that if either statement has side effects, those side effects will occur as part of screen prediction. To mitigate this problem, both statements now take a nopredict clause that prevents screen prediction.
Ren'Py will now attempt to predict images inside if clauses that would not be taken, and will ignore errors that occur during statement prediction.
A pair of functions, renpy.start_predict_screen() and renpy.stop_predict_screen() allows for manual prediction of time images that will be used by screens, including parameterized screens.

Ren'Py now supports profiling of screens, via the renpy.profile_screen() function.

Ren'Py has been changed to make a copy of the screens being displayed before a transition occurs. This makes it possible to use a transition to show screen updates. For example, one could increase the value displayed by a bar, and then use the dissolve transition to dissolve in the new segment of bar.

Image Prediction link

Ren'Py now has a supported mechanism for manually predicting images in cases where automatic image prediction fails. This mechanism consists of two functions: renpy.start_predict() starts prediction of images, while renpy.stop_predict() stops prediction.

Accessibility link

Ren'Py now includes support for self-voicing, a mode in which Ren'Py will read on-screen text to vision impaired players. To activate self-voicing, press the v key. For more information, please read the self-voicing documentation.

The new alt style property allows one to supply alternative text that allows Ren'Py to voice imagemap components and buttons with incomplete names.

The Ren'Py launcher now includes a large-text mode that can be accessed from the preferences page. This mode increases text size and contrast.

Android In-App Purchasing link

This version of Ren'Py includes a high-level interface that supports in-app purchasing on the Android platform. This interface currently support Google Play and the Amazon App Store.

Pixel Art link

Ren'Py supports nearest-neighbor filtering of images. This ensures that screen pixels correspond to a single texture pixel, which is the scaling mode preferred for use with pixel art. Nearest-neighbor mode is enabled with the new nearest transform property.

The new config.adjust_view_size() callback makes it possible to set the size of the Ren'Py viewport to something other than the size of the window (or screen, in fullscreen mode). For example, a game can use this callback to limit its viewport size to integer multiples of its native size.

Voice Improvements link

Voice volume is now adjustable on a per-character basis, using the voice_tag argument to Character() and the new VoiceVolume() value.

Using the new config.emphasize_audio_channels variable, Ren'Py can emphasize audio on some channels. This is doen by lowering the volume of non-emphasized channels when a emphasized channel is playing, and returning the volumes to normal when no emphasized chanels are playing. By setting this variable to [ 'voice' ], the voice channel can be emphasized over music and other sounds,

OS X Bug Workaround link

To workaround a bug in Mac OS X 10.9, Ren'Py will now always open on the the primary monitor of a Macintosh.

Translations link

This release add an Italian translation of the launcher and template game, contributed by Oshi-Shinobu.

This release adds a Portuguese translation of the template game, contributed by Mrstalker.

This release adds a Simplified Chinese translation of the launcher, contributed by Huanxuantian.

Ren'Py 6.17.7 link

This release includes a number of Android changes:

RAPT has been updated to use the latest version of the SDK. Please install the SDK again if you have build problems.
RAPT no longer includes a copy of Ren'Py. Instead, Ren'Py includes a copy of itself into the built game that RAPT uses. This makes it possible to include fixes to Ren'Py in an Android package.
A low-level In-App Purchase implementation, contributed by Emmanuel Marty and Winter Wolves. The low-level IAP code supports Google Play and the Amazon App Store. This code is not currently documented, as it will be wrapped in a higher-level implementation.

This release includes a fix to an audio-video sync issue that affected the Windows, Mac OS X, and Linux platforms.

Ren'Py 6.17.6 link

This release adds a German translation of the launcher, contributed by Marcel.

This release adds a Korean translation of the launcher and template game, contributed by Baekansi.

This release includes a workaround for an issue that could prevent the launcher from starting on certain Mac OS X computers.

Ren'Py 6.17.5 link

Translations link

This release features an Arabic translation of the launcher and template game, contributed by Renoa.

The Japanese and Spanish translations have been updated.

Changes link

The traceback system has been changed to generally report script statements, rather than the functions Ren'Py uses to implement those statements.

The renpy.pause() function now only sets a checkpoint (allowing rollback) if the delay time is 0. This prevents rollback from being blocked by short pauses.

The new renpy.queue_event() function provides a way to queue Ren'Py events from user-written interface code. (For example, it could be used to listen to commands on a serial port that's connected to a custom controller.)

If set, RENPY_SKIP_MAIN_MENU and RENPY_SKIP_SPLASHSCREEN environment variables cause Ren'Py to skip the main menu and splashscreen, respectively.

The RENPY_TIMEWARP environment variable makes it possible to speedup and slow down time.

An experimental new autoreload system can be accessed by setting config.autoreload to True, then pressing Shift+R to toggle automatic reloading.

Fixes link

A regression in 6.17.4 caused a major memory leak on Shift+R. This has been fixed. Several other problems with Shift+R have also been fixed.

An issue preventing transitions from working properly inside a restarted ATL transform has been fixed.

The --warp was documented incorrectly, and had stopped working. It's been repaired, and its documentation has been improved.

Ren'Py 6.17.4 link

Reloading link

This release contains a complete rewrite of Shift+R reloading.

The rewrite was necessary to eliminate several major memory leaks that were triggered by reloading.

Android link

Ren'Py has been updated to use the newest (at the time of release) versions of the Android SDK and Ant. This should fix build problems caused by the use of older versions.

Ren'Py now recognizes and supports the Amazon Fire TV device. When a Fire TV is detected, the "firetv" screen variant is selected. To support pushing games to this device, Ren'Py now supports connecting to Android devices via the Remote ADB protocol.

Ren'Py 6.17 link

Styles link

The style system, which makes it possible to configure the look of displayables, has been rewritten from scratch. The new code reduces the amount of time it takes to create a new style to a small fraction of the previous time. Since every displayable creates an associated style, this has the potential to lead to a substantial performance improvement.

This release also introduced a new style statement that can be used to define styles, in place of Python code. (Of course, the older form remains fully supported.) Lengthy and redundant code like:

init python:
    style.quick_button_text.set_parent('default')
    style.quick_button_text.size = 12
    style.quick_button_text.idle_color = "#8888"
    style.quick_button_text.hover_color = "#ccc"

can be replaced with:

style quick_button_text is default:
    size 12
    idle_color "#8888"
    hover_color "#ccc"

Finally, the style inspector (accessed through Shift+I) has been rewritten.

Syntax Changes link

In addition to the new style statement, there are four other syntax changes:

The definition of a simple expression has been expanded. Simple expressions (which are used in ATL and the screen language, among other places) now encompass all Python expressions that do not include lambda or the ternary (... if ... else ...) operator.

This means that code like:
```
show logo:
    xpos 800 / 2
```
is now legal. Previously, the expression had to be parenthesized.
The new show layer statement allows one to apply a transform or ATL transform to an entire layer, using syntax like:
```
show layer master at flip
```
or:
```
show layer master:
    xalign 0.5 yalign 0.5 rotate 180
```
The new window auto statement makes it possible for Ren'Py to automatically show and hide the dialogue window. By default, it is shown before say statements, and hidden before scene statements, but this can be customized.
The init statement has been extended so it can be combined with other statements. It's now possible to write "init 1 image = ...", "init -2 define name = ..." and so on.

Translations link

This release adds French and Russian template games and translations of the launcher.

Android link

It is no longer necessary to download RAPT (the Ren'Py Android Packaging Tool) separately from Ren'Py. As of this release, RAPT will be downloaded by the Ren'Py launcher when an Android build is requested, and will be updated by the Ren'Py updater.

Buttons may now have an alternate action that is triggered by longpress on Android and right-click on desktop computers.

This release fixes a bug in which Ren'Py would not save persistent data (including preferences) before being terminated by the Android system, and a regression that broke compatibility with some Android 2.3 systems.

New and Changed Preferences link

There are two new preferences accessible through the Preferences() function:

"auto-forward after click" controls if auto-forward mode is stopped by a click.
"show empty window" determines is if the "window show" and "window auto" statements will cause an empty window to be shown.

Neither of these is exposed as part of the default preferences screen, but both can be added by interested developers.

There is one changed preference:

"display" now has an "any window" option, which restores a fullscreen Ren'Py to its prior windowed size.

Ren'Py 6.16.2 link

This release adds a Spanish translation of the launcher and the template game.

This release adds the new renpy.get_mouse_pos() function, which retrieves the mouse position if a mouse is supported.

Ren'Py 6.16 link

Android link

Android support has now been integrated into the Ren'Py launcher. While for size reasons RAPT is still a separate download, once RAPT has been placed inside the Ren'Py directory, the launcher will allow you to:

Install the Android SDK.
Configure a project as an Android application.
Build and Install the Android application.

The launcher can now launch Ren'Py in modes that simulate Android phones, tablets, and television-based consoles.

Ren'Py includes support for television-based Android consoles, such as the OUYA. It includes support for detecting the OUYA specifically, and choosing a variant as appropriate.

This release adds some video playback support to the Android port. While limited to full-screen video and codecs that the Android platform supports (which unfortunately have little overlap with desktop Ren'Py), this may be enough to enable cutscene movies.

Ren'Py now includes a new set of screen variants, with "large", "medium", and "small" reflecting the visual size of devices (televisions are considered to be small because they're far away), while "touch", "tv", and "pc" reflect the input devices involved.

Android now supports displaying vertical text.

Save, Load, and Persistent Improvements link

The low-level load/save API has been overhauled. It's now possible to access save slot information directly, instead of having to scan all save slots to find the one you want. New functions include renpy.list_slots(), renpy.newest_slot(), renpy.slot_mtime(), renpy.slot_json(), and renpy.slot_screenshot().

At a higher level, there is a new FileNewest() function that's true for the newest save slot. FilePageNext() and FilePagePrevious() now support a wrap argument that causes them to wrap around a defined number of screens.

There is now support for adding arbitrary JSON information to save files. This allows per-save information (like the path you're on in a VN, date and amount of money in a sim, or party composition in an RPG) to be accessed from the save and load screens.

JSON information is created by config.save_json_callbacks, and can be accessed through the low-level renpy.slot_json() or high-level FileJson() functions.

When possible, Ren'Py now stores save files with the game, as well as in a user-global save directory. This means that if a Ren'Py game is placed on a USB drive or shared on a network, the saves will be available on multiple computers. (When save files are available in both places, the newest file wins.)

When a save file on a network share is updated, Ren'Py will automatically rescan the contents of that file, and restart the current interaction. (This will update the save and load screens, making the file available to be loaded.)

Ren'Py will no longer auto-save while at the main menu.

Persistent data is also stored in both locations. When the persistent data is not identical, it will be merged. By default, the most recently updated value for each field will be used. In some cases (for example, a set of endings the player has reached), this is not the correct behavior. The new renpy.register_persistent() can be used to register different merge behavior.

Voice link

This release adds support for playing voice without having to fill the script with voice statements. This support consists of two new pieces of functionality:

The launcher contains a new "Extract Dialogue" function. This extracts the dialogue into a tab-delimited file. Each record includes the character, the dialogue text, the filename and line number, and a unique identifier for that line.
The config.auto_voice variable is used to give a filename pattern that is formatted with the unique identifier. If a file with that filename exists, and no other voice file is being played, that file is used as the voice.

There are also several new voice-related preferences. The "voice sustain" preference determines if voice is sustained through multiple interactions. The "wait for voice" preference determines if auto-forward mode waits for the voice to finish before advancing.

Image Gallery and Music Room link

The image gallery now can display a navigation overlay with next, previous, slide show, and return buttons. The creator can choose if these buttons display the images associated with a single button, or advance between multiple buttons.

The Music Room includes the ability to play a random track, and to determine if the tracks are shuffled, looped, or if play is confined to a single selected track.

Text Rendering link

Ren'Py now renders portions of font characters that leave the character bounding box. This prevents text (especially hinted and anti-aliased text) from being cut off, but may lead to apparent placement problems for fonts with very inaccurate bounding boxes.

Japanese Language link

The Ren'Py launcher has been translated into Japanese. The language used by the launcher can be switched from the preferences screen.

There is now a Japanese language template game, which defaults to a Japanese font and has a translated interface.

Much of the documentation has been translated to Japanese. The Japanese translation can be found at:

http://ja.renpy.org/doc/html/

Documentation link

The Ren'Py documentation has been improved. The following pages have been added or migrated from the old wiki-based documentation.

Many other documentation pages have been improved and edited.

Bugfixes link

This release includes many bugfixes. Some of the more important are:

A fix to a problem that would cause Ren'Py to restart the display when starting up on Windows. This could cause Ren'Py to spuriously detect a slow video card, and present the user with the appropriate error message.
A fix to a problem where Ren'Py would fail to display the proper error message when Python code containing non-ASCII characters fails to compile.

Ren'Py 6.15.6 link

This release includes improvements for the Android platform:

Assets are now read exclusively from the APK and expansion file.
Logs and tracebacks are placed on external storage.
Saves are placed on external storage, except when saves from older versions of Ren'Py exist.

The GL2 shaders Ren'Py uses have been simplified in the (usual) case where no clipping is occurring. This leads to a noticeable speed improvement on Android, and potentially other platforms as well.

An issue with Drag-and-drop has been fixed. Thanks go to Kinsman for contributing this fixe.

The Skip() action now triggers the skip indicator. It also supports a new fast parameter, which causes skipping to the next menu.

This release includes various minor changes to improve compatibility with very old Ren'Py games. (It now runs the Ren'Py 5 demo.)

Ren'Py 6.15.5 link

This release adds two new features:

The GL renderer now supports additive blending. This is enabled using the additive transform property in an ATL transform or use of the Transform() class. Additive blending will not work if the software renderer is in use, and it's up to creators to deal with that issue.
The new Flatten() displayable combines multiple textures into a single texture. This can be used to prevent incorrect behavior when a displayable containing multiple overlapping textures (like a LiveComposite() is shown with an alpha between 0 and 1.

It also fixes the following issues:

Whitespace is now skipped before default arguments, which previously caused parse errors in some cases.
Ren'Py now sets the unix mode of files and directories in zip and tar files to 644 and 755 as appropriate. Prior versions of Ren'Py used 666 and 777 as the permissions, which lead to a security problem when the file was unpacked by a tool that didn't respect the user's umask. (Info-zip had this problem.)
Auto-hinting for fonts is now enabled by default. This restores font rendering compatibility with prior releases.
Ren'Py now builds with and requires the current version of libav. It should also work with current versions of ffmpeg when libav is available.
The version of SDL distributed with Ren'Py has been patched to prevent multiple windows from showing up in the Window menu when entering and leaving fullscreen mode.

Ren'Py 6.15.4 link

This release fixes a compile problem that prevented Ren'Py 6.14.x and Ren'Py 6.15.0-3 from running on most 64-bit Linux systems.

Image prediction has become more fine-grained, and can take place while the screen is animating.

The new build.exclude_empty_directories determines if empty directories are include or excluded from the distribution. It defaults to true, previously the default was platform-dependant.

Ren'Py 6.15 link

Translation Framework link

Ren'Py now includes a comprehensive translation framework. This framework includes support for using a single language selection to change dialogue, menus and other interface text, images and files, styles and styles.

The dialogue translation support allows lines of dialogue to be split and combined at the translator's discretion. As most Ren'Py statements are allowed inside the new translation blocks, it's possible to use logic (like conditions) to tailor the translations to your language.

The launcher includes a new "Generate Translations" button, which – as part of a sanctioned translation where the full script is present – will generate empty translation files for a new language.

Improved Japanese Support link

Ren'Py 6.15 includes multiple changes to better support the Japanese language.

The tutorial game has been translated to Japanese, with the language being selectable from the preferences menu.

The tutorial was translated by Koichi Akabe.
Support for vertical writing has been added to Ren'Py. Consisting of the vertical style property for text, and the new box_reverse property on hboxes, this support makes it possible to display dialogue, menus, and other text in a vertical orientation.

Vertical text support was written by Koichi Akabe.
The line-breaking algorithm has been updated to match Unicode 6.2. In addition, three new "languages" have been added. The new "japanese-strict", "japanese-normal", and "japanese-loose" languages (based on the line-break options in the CSS3 Text module) allow greater control of how Ren'Py breaks lines with small kana and other special characters.

Linebreaking can be further tailored using the new renpy.language_tailor() function, which can change the linebreaking class of a character.

Console link

The new debug console makes it possible to interactively run Ren'Py script and Python statements, and immediately see the results. The console is available in developer mode or when config.console is True, and can be accessed by pressing Shift+O.

The console can be used to:

Jump to a label.
Interactively try out Ren'Py script statements.
Evaluate a Python expression or statement to see the result.
Trace Python expressions as the game progresses.

The console was originally written by Shiz, C, and delta.

Screen Parameters link

Screens now take named parameters, similar to the way that labels and transforms take named parameters. It's now possible to write:

screen top_text(s, size=36):
     text s xalign 0.5 size size

and:

show screen top_text("It works!")

Replay Gallery link

Ren'Py now includes support for replaying scenes. A scene replay can be invoked from anywhere in Ren'Py (for example, from a main menu or game menus screen, even when the game has started). When the replay ends, Ren'Py will return to the location the replay was invoked from, even if that location is in a screen or in Python code. Rollback works inside a replay, but saving and loading is disabled.

The Replay() action begins a replay. The renpy.end_replay() ends a replay if one is in progress, and is ignored otherwise.

Voice Improvements link

There have been several improvements to the voice playback system. The new config.voice_filename_format variable makes it possible to use only part of the filename in a voice statement. The new voice_tag parameter to Character(), in conjunction with the SetVoiceMute() and ToggleVoiceMute() actions, makes it possible to selectively mute particular characters' voices. The new VoiceReplay() action makes it possible to replay the current voice.

Launcher Improvements link

There were a few launcher improvements in this release.

The files pane of the navigation page has a new button that allows the user to create a new script file.
The launcher can generate translation templates, and can be translated using the translation framework.
The Ren'Py launcher now has a small amount of support for skins. While the basic layout of the launcher remains fixed, skins allow the background images and colors to be changed. See the skin documentation for more details.

Macintosh Changes link

The Macintosh version of Ren'Py now requires a 64-bit capable processor, and Mac OS X 10.6 or newer.

Packaging Improvements link

The file layout of Ren'Py games has been somewhat altered. With the exception of small launcher programs, all platform-dependent binaries are under the lib/ directory. Ren'Py itself has now been placed in the renpy/ directory. The common/ directory has been moved to renpy/common/, as it's considered an integral part of Ren'Py.

Ren'Py now uses renamed but otherwise unmodified Python binaries on all desktop platforms. (Previously, it used platform-specific binaries.) Portions of the library are shared between the desktop builds.

A running Ren'Py process on Linux will now be named after the game, rather than having python as a name.

Bugfixes link

Among others, the following bugs were fixed:

github bug 37: A crash with LiveTile when sizes were not integers.
github bug 41: renpy.loadable() failed to search for files inside android packages.
github bug 42: The launcher can now run a game that's in a read-only directory.
github bug 45: Ren'Py would fail when the hiding of a screen caused a screen beneath it to be hidden.
github bug 46: A bug that prevented Ren'Py from evicting images from an over-full image cache, that manifested as a runaway memory leak.
github bug 50: Vertical bars would scroll with the left and right arrow keys; and bars would remain grabbed even if they were grabbed while leaving the screen, preventing further input.
github bug 51: The slow_done callback was not called after a rollback.
github bug 56, github bug 57: renpy.loadable() now works with Android assets.
github bug 60: Fixed a bug that prevented {p} and {w} from working properly when followed immediately by a text tag.
github bug 61: Ren'Py no longer crashes when an end_game_transition is set and a screen uses a variable that is no longer defined when the game restarts.
github bug 65: Multiplying a rollback list by a number now always produces a rollback list.
Editra should work better on Windows.
It's now possible to renpy.call() a label that doesn't take parameters.
Fixed an error handling failure when a style used by error handling was not buildable.
Fixed an error handling failure when a python early block contained a syntax error.

Ren'Py 6.14 link

Ren'Py Launcher Rewrite link

The Ren'Py launcher has been rewritten. Some of the improvements are:

A new visual design by Doomfest of the Dischan visual novel team.
The launcher now includes direct access to open the script and game directories, and common script files.
The launcher includes Script Navigation support. Clicking the name of a label, define, transform, screen, or callable will open the editor to the location where that name is defined.

Script navigation also provides access to individual script files.
The launcher now supports one-click project building. Instead of using multiple steps to build a project, a single click will now cause the launcher to:
- Read the build process configuration from the game script.
- Build the archives needed.
- Generate the archive and update files.
The launcher can now use the Ren'Py updater to update Ren'Py, and to download editors.

Editra & Text Editing link

For most users, Ren'Py recommends the use of the Editra editor. We have developed an Editra plugin that communicates with the Ren'Py launcher and supports the editing of Ren'Py script.

While still in beta, Editra is a fast and light editor with good code editing support. Editra also includes a spell-checker that can be enabled, and applies to dialogue and other strings.

If Editra is selected by the user, and it is not installed, Ren'Py will automatically download it.

The jEdit editor remains supported, and is preferred for use with languages (like Chinese, Japanese, and Korean) that Editra doesn't support fully. If selected, Ren'Py will download jEdit automatically.

Ren'Py also supports editing files through system-specific file associations. (This support will not send the cursor to the correct line, however.)

Ren'Py Web Updater link

Ren'Py includes an updater that can update Ren'Py and individual Ren'Py games by downloading changes from a properly-configured web server with a small number of update files uploaded to it.

The updater uses zsync to download the minimal set of changes between the local files on disk and the files stored on the server. A single set of files on the server supports updating from all prior versions of a project.

Ren'Py includes a default updater interface that can be further configured by interested users.

Transform Changes link

This release changes the behavior of transforms to make them more correct and easier to use.

The xzoom and yzoom properties are now applied before, rotation. This means that the shape of the image will remain consistent as the image is rotated. Previously, the image to change shape as it was rotated.

The xzoom and yzoom properties may now be negative, with negative zoom values causing the images to be flipped. The positioning code now takes this into account, and positions a flipped image properly.

Thanks to Edwin for contributing these changes.

Screen Language, Displayable, and Transition Enhancements link

The Textbutton and Label screen language statements now take properties prefixed with text\_. These properties have the text_ prefix stripped, and are then passed to the internal text displayable.
The Viewport screen language statement now takes a scrollbars parameter. If given, scrollbars that manipulate the viewport are created.
The Viewport screen language statement now takes xinitial and yinitial parameters. If given, these control the initial positioning of the viewport.
A screen language block may now contain multiple has statements. Screen language widgets that take single children can now take a has statement.
The input displayable now supports the use of the left and right arrow keys within the text. (Thanks to Edwin for this feature.)
MoveTransition() has been rewritten. The new version now uses transforms to control the positioning of entering and leaving images, and can interpolate between the locations of moving images.

Rollback Improvements link

The new renpy.fix_rollback() function allows the game to fix choices, even if they are made in rollback mode. The user can roll back and roll forward, but is restricted to making the choices he made the first time through the game.

Thanks to Edwin for contributing fix_rollback.
Rolling forward now works through a jump out of a call screen statement.

Video Improvements link

Ren'Py's video playback support has been partially rewritten to improve robustness, speed, and framerate stability. These improvements should reduce the number of frame drops Ren'Py performs, and should also prevent Ren'Py from locking up if too many frames are dropped.

Ren'Py now supports the WebM video format.

Image Load Log link

When config.developer is true, Ren'Py keeps an internal log of image loads.

This log can be access by showing the _image_load_log screen. This screen displays the name of an image file for a few seconds after that image has been loaded. The name is in white if the image was loaded by the image predictor, and pink if Ren'Py was unable to predict the image.

File Actions and Functions link

Two screen functions have been added, and two screen actions have been changed:

The new FileUsedSlots() function returns a list of used file slots on the current page.
The new FileCurrentPage() function returns the name of the current page.
The FileSave() and FileAction() actions have been modified so that if the slot name is None, an unused slot based on the current time is used.

Taken together, these changes make it possible to create a list of save slots where the user is able to add new slots to the list.

Multiple Store Support link

Ren'Py now supports multiple stores – multiple namespaces in which Python code can be run. Variables in these stores are saved, loaded, and rolled-back in the same way that variables in the default store are.

Stores are accessed by supplying an in-clause to a python block. For example:

init python in stats:

    def reset():
        """
        Code to reset the statistics.
        """

User-created stores are placed into the "store" package, with the default store being the package itself. Names can be imported between packages.:

init python:
    from store.stats import reset

init python in stats:
    from store import ToggleField

Note that stores do not affect the order in which init python blocks are run. A name must be defined in a block before the one that imports that name.

Platform Support and Library Updates link

Linux support has been changed.

The Linux platform supports the x86_64 CPU architecture in addition to the x86 architecture. The Ren'Py shell script will automatically determine the platform it is running on when it is launched.
The Linux version is now linked against the libraries from the 2009-era Ubuntu 10.04 Lucid. (Previously, Ren'Py had been linked against 2006's Dapper.) Older versions of Linux are no longer supported.

Many libraries that Ren'Py depends on have been updated. Some of the changes that have occurred are:

Python has been updated to version 2.7.3.
Pygame has been updated to version 1.9.1.
GLEW has been updated to version 1.7.0. This may fix OpenGL problems on some Linux systems.
LibAV has been updated to version 0.7.6, and has been compiled with CPU detection enabled.

Ren'Py 6.13.9 link

The new RAPT tool makes it far easier to package a Ren'Py game for Android. It can semi-automatically set up an Android build environment on your system, build a package, and install that package on your Android device.

To fix some editor-related problems, backported the 6.14 editor system. This changes how editors are configured. Please see エディターとの統合 for a description of the new system.

The new config.save_dump variable causes Ren'Py to write out save_dump.txt each time it saves. This file describes the contents of the save, making it possible to figure out what's causing an overly large save file.

Worked around a bug in Mesa that can cause crashes on certain Linux systems.

Fixed the following bugs in Ren'Py.

The (default) texwrap layout represents character widths as floating-point numbers. This fixes a bug where non-integer kerning would lead to text overflowing its bounding box.
Menu choices are logged correctly.
All file access is now done in Unicode, rather than the system's native encoding. This prevents crashes that occurred when Ren'Py was placed in a directory that had non-ASCII characters in it.
Fixed focus_mask on the ANGLE renderer.
Displayables can now have fractional-pixel sizes. This allows a zooming image to remain precisely centered on the screen.
Fixed a problem where Ren'Py would save unnecessary trees of displayables each time it saved a screen. This would lead to overly large save files and slow save performance.
Ren'Py would not attempt an alternate rendering method if the texture test failed, leading a "Textures are not rendering properly." exception.
A crash in Render.fill.

Ren'Py 6.13.8 link

Side images can now be limited to showing a single character, or only showing characters that are not on the screen. See config.side_image_tag and config.side_image_only_not_showing.

Added config.python_callbacks, a list of Python functions that are called at the end of each python block.

Ren'Py now tests the video card it is running on for functionality. If it can't draw textured rectangles to the screen, it will proceed to a different renderer.

Old-style string interpolation is now enabled by default, alongside new-style string interpolation.

Ren'Py is now compatible with libpng 1.5. Thanks to James Broadhead for the patch.

Fixed the following bugs:

A crash when dealing with certain invalid fonts.
Pausing too long when typing out text.
Cutting one pixel off a block of text when fractional kerning was used.
Crashing when the time was set in the far future or past.
Immediately exiting when rolling forward at the quit prompt.
Crashing when a non-existing directory is added to the search path. (This prevented Katawa Shoujo from starting in the latest version.)
Save-file size was overly large due to screens being included in save files.

Ren'Py 6.13 link

Text Rewrite link

Text display has been rewritten from scratch. In addition to supporting many new features, the new implementation of Text is much faster at text layout and display, and contains much cleaner code.

Some of the new features that are now supported by the text display system are:

Interpolation of variables enclosed in square brackets. It's now possible to write code like:
```
"You scored [score] out of a possible [max_score] points."
```
The new string interpolation takes place on all text that is displayed, rather than just say and menu statements. When used as part of a screen, interpolation has access to screen-local variables.

PEP 3101-style string formatting is supported, which means that this syntax can be used to display fields and items, as well as variables.
Kerning support was added, both as the kerning style property and the k text tag.
Support for ruby text (also known as furigana), via the rt and rb text tags, and the ruby_style style property.
The new space and vspace text tags make it easy to whitespace into the text.
The new cps text tag controls the speed of text display.
By default, Ren'Py uses the Unicode linebreaking algorithm to find points at which a line can be broken. This algorithm should correctly break lines that contain a mix of western and eastern languages. Since that algorithm is incorrect on some Korean texts, Ren'Py also implements a korean-with-spaces variant, that only breaks runs of Korean text at whitespace. These algorithms can be selected by the language style property.
Ren'Py now uses the Knuth-Plass linebreaking algorithm to choose the points at which it actually splits lines. This algorithm attempts to minimize the unevenness of all lines except the last. Ren'Py also supports a nobreak mode, which allows one to create a Text larger than the screen without it being automatically wrapped. These can be selected using the layout style property.
The new newline_indent style property determines if Ren'Py adds indentation after a newline in text.
The new line_leading style property inserts space above a line of text. (Ruby text can be placed into this space.)
Text can be automatically translated before it is displayed. (This support will be improved in a future major release.)

DirectX Support link

On Windows systems that have the February 2010 DirectX update installed, Ren'Py will use DirectX via the ANGLE adaptation layer, if OpenGL 2.0 or later is not found. The ANGLE layer is used by popular web browsers such as Firefox and Google Chrome. This allows hardware rendering to be used on netbooks, where drivers often support DirectX far better than OpenGL.

At startup, Ren'Py will test the graphics capabilities of the computer it is running on. If the software render is being used, or the game renders at an unacceptably slow speed, Ren'Py will display a warning message to the user. The warning message includes a link to a page on renpy.org that explains how to update the graphics drivers.

This version of Ren'Py will only use the software renderer if both DirectX and OpenGL are incapable of rendering Ren'Py games. Screen-scaling in the software renderer has been replaced by a simpler but slower version.

Ren'Py 6.12.2 link

This release contains the following changes:

ATL Transforms with parameters compile correctly.
MultipleTransition works in conjunction with pauses.
The mouse is shown when a quit action is run while a movie is playing.
A fix for a lockup that occurred when the user entered the game menu while a transition was running.
RENPY_SCALE_FAST works again.
Ren'Py compiles with newer versions of ffmpeg.
Skipping ends when the game restarts.
Fixed a problem with texture upload that made games noticeably slower.
Choose a better default size for windows on small monitors, like netbooks.
xfill and yfill now work for vbox and hbox, respectively.
Click-to-continue fixes.
Side image fixes.
Documentation fixes.

Thanks to David Gowers and zhangning for contributing patches to this release.

Ren'Py 6.12.1 link

Image Attributes link

The process of showing images is now attribute-based. Image names now consist of a tag, and zero or more attributes. When showing an image, the order of attributes is no longer important – it's now possible to define an image using one set of attributes, and show it using those attributes in a different order.

Attributes are also "sticky". This means that we attempt to preserve as many attributes as possible when showing a new image.

For example, say we had the following images:

image eileen beach happy = "eileen_beach_happy.png"
image eileen beach woozy = "eileen_beach_woozy.png"

We can now show the first image using the command:

show eileen happy beach

Since the order of attributes no longer matters, this will show the "eileen beach happy" image. If we follow this with the show statement:

show eileen woozy

the image "eileen beach woozy" will be shown. (Assuming no other images exist. If the image "eileen happy woozy" existed, an ambiguity error would occur.)

When an image tag is shown without any attributes, then the current attributes are retained. Now, one can write:

show eileen at right

to display Eileen on the right side of the screen, without changing the attributes supplied to an image.

Say Attributes. Image attributes can be updated as part of a say statement. A character can be given an image argument, giving the name of an image that character is linked to. As part of the say statement, image attributes can be given before the dialogue string. These attributes are given to the linked image.

For example, if we define a character using the code:

define e = Character('Eileen', image="eileen")

the code:

e woozy "I think I'm getting too much sun."

is equivalent to:

show eileen woozy
e "I think I'm getting too much sun."

whenever an image with the tag eileen is being shown.

Side Image. This release features a new implementation of サイドイメージ, which allows side images to be defined like other images, and allows side images to be integrated with screens easily.

Sticky Transforms. Finally, showing an image without providing a transform or ATL block will now continue the previous transform that an image with that tag was using. Previously, it caused those transforms to stop.

Error Handling link

Ren'Py now has a new exception handing framework. Instead of always crashing when an error occurs, Ren'Py will now display the error message on the screen, and give the user the following choices, as appropriate to the situation:

Rollback
Reload
Ignore
Open Traceback
Quit

When an editor is defined, Ren'Py will allow the user to click on a filename and line number to open that line in the editor.

The framework is used to handle exceptions and parse errors.

Ren'Py 6.12.0 link

Android Support link

Ren'Py now supports the Android platform. This includes support for a large fraction of Ren'Py's functionality, although we were unable to add support for imagedissolves and movie playback. It should be possible to package a Ren'Py game and distribute it through the Android market.

Android support required several changes in Ren'Py:

The OpenGL renderer has been extended to support OpenGL ES.
For performance reasons, much of the display system has been rewritten in the Cython language. This also should improve performance on other platforms.
Support was added for the Android lifecycle. Ren'Py automatically saves when the android device suspends, and reloads (if necessary) upon resume.
We added the concept of スクリーン variant. This allows a single game to have multiple interfaces – such a mouse interface for computer platforms, and a touch interface for Android-based smartphones and tablets.
We built a system that allows one to package a game separately from Ren'Py. This allows one to build packages without having to set up the Android NDK (you'll still need the Android SDK, Java, Python, Ant, and a lot of patience).

Ren'Py also now creates a number of binary modules that live in the renpy.display package. As long as they go in the same place as _renpy.so, they should be picked up automatically.

New Widgets and Displayables link

Added the SpriteManager displayable. This provides a high-performance way of drawing many similar sprites to the screen. This can scale to hundreds of particles, provided those particles are mostly similar to each other.

Added the Mousearea widget. A mousearea allows hovered and unhovered callbacks to occur when the mouse enters and leaves an area of the screen. Since it doesn't participate in the focus system, a mousearea can include buttons and bars.

Added ドラッグ＆ドロップ widgets and displayables. The drag and drop system can support:

Windows being repositioned by the user.
Card games.
Inventory systems.
Drag-to-reorder systems.

Image Prediction link

Ren'Py is now better at predicting image usage. Along with predicting images used by normal gameplay, it now attempts to predict images that are used by screens one click away from the user. For example, during normal gameplay, it will predict images on the first screen of the game menu. While at the game menu, it will predict the other screens of the game menu, and also the images the user will see when returning to the main menu. This prediction is automatic, but only occurs when using screens.

Screens may be invoked at any time, in order to allow for image prediction, unless they have a predict property of False. This means that displaying a screen should not have side effects. (Most screens only have side effects when a button is clicked or a bar changed – that's still fine.)

Ren'Py now supports hotspot caching for screen language imagemaps. When config.developer is true, Ren'Py will write a PNG file in the game/cache/ directory containing image data for each of the hotspots in the imagemap. If the cache file exists (regardless of the config.developer setting) it will be loaded instead of loading the hotspot images. As the cache file is often much smaller than the size of the hotspot images, it will load faster and reduce image cache pressure, improving game performance. This behavior only applies to screen language imagemaps, and can be disabled with config.imagemap_cache.

This should remove most of the need for renpy.cache_pin(). While not an error, the use of cache pinning can cause unnecessary memory usage when the wrong image is loaded.

Screens link

Ren'Py now ships with a default set of screens, which are used by the demo and installed by default when a new game is created. You can find them in template/game/screens.rpy, and they can be used by copying that file into your project. These screens are not 100% compatible with the previous layout system – for example, some styles have changed. That's why games must opt-in to them.

The definition of the items parameter of the Choice and NVL screens has changed, and games will need to be updated to work with the new version.

Character arguments beginning with show_ are passed to the Say screen. This allows things like show_side_image and show_two_window to work with screens. The screens we ship support these options.

The new config.imagemap_auto_function variable allows the game-maker to control the interpretation of the auto property of imagemaps and imagebuttons.

The imagemap caching behavior described above applies only to screens.

The FilePageName() and FileSlotName() functions make it easier to name slots

Bug Fixes link

launchpad bug 680266 - Ensures that dynamic displayables update before Transforms that use them.
launchpad bug 683412 - Do not crash if a shader fails to compile.
Fixed a bug that caused Ren'Py to crash when the system volume was lowered to 0, but not muted.
Fixed a bug that prevented Render.canvas() from working with the OpenGL renderer.

Ren'Py 6.11.2 link

New Features link

This release includes four new themes, generously contributed by Aleema. You can see and change to these new themes by clicking the "Choose Theme" button in the launcher.

Software Update link

The jEdit text editor included with Ren'Py has been updated to version 4.3.2, a supported version that should be able to run most plugins.

Behavior Changes link

The maximum default physical size of the Ren'Py window is now 102 pixels smaller than the height of the screen. This should prevent Ren'Py from creating windows that can't be resized since they are much bigger than the screen.

Buttons now only pass key events to their children when they are focused. This allows a screen language key statement to be used as the child of a button, and only activate when the button is focused.

MoveTransition was rewritten to correctly deal with cases in which images changed their order. This may lead to differences in behavior from the old version, where the ordering was undefined.

Bug fixes link

Fixed launchpad bug 647686, a regression that prevented sounds from looping properly.

Fixed launchpad bug 661983, which caused insensitive hotspots to default to the idle, rather than ground, image when no insensitive image was supplied.

Fixed launchpad bug 647324, where ImageDissolves are rendered as if specified with alpha=True whether or not alpha=True was set.

Fixed a problem that caused the game to start when picking "No" after clicking the (window-level) quit button.

Fixed a problem that prevented AnimatedValue from functioning properly when delay was not 1.0. Thanks to Scout for the fix.

Fixed a problem that caused movies to display incorrectly when the screen was scaled using OpenGL scaling.

Ren'Py 6.11.1 link

New Features link

Add the AlphaBlend() displayable and the AlphaDissolve() transition. These take two displayables, and use the alpha channel of a third displayable to blend them together. (The third displayable is often an animation, allowing the effect to change over time.)

The new modes system allows one to invoke callbacks when switching from one type of interaction to another. This can be used, for example, to automatically hide the window before transitions.

Imagemaps created using the screen language now only have a size equal to that of their ground image. (Previously, they took up the entire screen.) This change makes it easier to position an imagemap at a different location on screen, such as the bottom.

Imagemaps now take an alpha argument. If true (the default), hotspots are only focused if the mouse is over a non-transparent part of the idle or hover image. If set to false, the hotspot is focused whenever the mouse is within its boundaries.

Added the renpy.focus_coordinates() function, which returns the coordinates of the currently focused displayable, when possible.

The new renpy.notify() function and Notify() action make it simple to flash small status messages on the screen, such as might be used to notify the user of a completed quicksave or screenshot.

The new HideInterface() action allows the interface to temporarily be hidden, as a screen language action.

The developer menu now includes a command that will list all the files in the game directory.

The urllib and urllib2 modules from the Python standard library are now distributed as part of Ren'Py. These modules allow data to be retrieved from web servers.

The launcher now includes an experimental updater, that makes it easier to update to the latest pre-release. Hitting Shift+U at the launcher's main screen will cause Ren'Py to be updated.

Fixes link

MoveTransition() now respects the xoffset and yoffset parameters.

Fixed several bugs with screen-language imagemaps.

Fixed a bug (#626303) that was caused by an incorrect texture unit check. Thanks to tmrwiz for the fix.

Transforms no longer cause a divide by zero exception when the zoom, xzoom, or yzoom properties are 0.

Clockwise and counterclockwise revolution in transforms now works.

Fixed a bug with scaling, that occurred when switching between the scaled software and GL renderers.

Hidden screens are no longer considered when assigning default focus.

FieldValues with max_is_zero set to True now work properly. Thanks to SleepKirby for the fix.

Ren'Py 6.11.0 link

OpenGL Support link

Ren'Py now depends on:

Python 2.6
OpenGL
The GL Extension Wrangler Library: http://glew.sourceforge.net/
The argparse Python module: http://code.google.com/p/argparse/

Ren'Py will now take advantage of a computer's OpenGL hardware acceleration, if supported. This OpenGL support has several user-visible changes:

The window containing a Ren'Py game can be resized or maximized, using standard window controls. When the window's aspect ratio does not match the game's aspect ratio, black bars will be added.
Displaying in full-screen mode should not change the monitor's resolution. This will prevent the game from being distorted when displayed on a monitor with a different aspect ratio.
Unless disabled in the video driver configuration, Ren'Py will use vertical blank synchronization, eliminating image tearing.
GPU rendering is used, which should make drawing the screen faster in most circumstances.

Software rendering is still supported, and Ren'Py will automatically fall back to software rendering if it detects an improperly configured video card.

You can test that Ren'Py is in OpenGL mode by attempting to resize the window. If it's resizable, it's OpenGL, otherwise, software rendering is being used.

Screens and Screen Language link

This release introduces a new screen system, which allows one to use the new screen language to declaratively specify portions of the user interface. The screen language supersedes layouts, overlay functions, imagemaps, and most other means of customizing the out-of-game menus and the in-game screens.

The previous way of customizing the behavior of the game menu, the layout system, had problems, especially when using imagemap layouts. Screens were single-purpose, and it would be difficult to (for example) load a quick-save game from the main menu, without extensive Python code.

The screen system addresses this by providing a pool of functionality, in the form of Actions and BarValues. This makes it possible to pick and choose functionality, and add it to screens as is deemed necessary.

Transform Changes link

If a transform does not define one of the position properties xpos, ypos, xanchor, or yanchor, that property will be taken from the transform's child, if the defines that property.

This makes it possible to have one transform control a displayable's vertical motion, and the other control the horizontal. But this is incompatible with previous behavior, and so can be disabled with the config.transform_uses_child_position variable.
The new config.default_transform variable allows a transform to specify the initial transform properties of an image that does not have a more specific transform applied to it. Its default value is center, a transform that shows the image at the center-bottom of the screen.

This can lead to a behavior change. When an image is shown, and then shown transforms, the transform will be initialized to the bottom center of the screen, not the top-left. The reset transform can be used to reset the position to the top-left.
Transform (and ui.transform) have been changed so that their arguments can now be prefixed with a style prefix. One can write ui.transform(idle_rotate=30, hover_rotate=90) and have it work.
Added the rotate_pad transform property, which controls how Transform pads rotated displayables. When set to False, _not_ the default, it's now possible to rotate a (100, 50) displayable by 90 degrees, and have the result be (50, 100) in size.

変更履歴 (Ren'Py 6.11 - 6.99) link

6.99.14.3 link

Changes link

Fixes link

6.99.14.2 link

Features and Changes link

Self-Voicing link

Fixes link

6.99.14.1 link

Image Prediction and Caching link

Other Improvements link

Other Fixes link

Ren'Py 6.99.14 link

Performance link

Multiple Character Dialogue link

GUI Preferences link

Tooltips link

Changes link

Fixes link

Ren'Py 6.99.13 link

Tutorial and The Question link

Interactive Director link

New GUI link

Raspberry Pi link

Hyperlinks link

Say with Arguments link

Translations link

Other link

Ren'Py 6.99.12.4 link

Console link

Other link

Ren'Py 6.99.12.3 link

GUI link

Translations link

Other link

Ren'Py 6.99.12 link

Macintosh Support link

Translation Changes link

Python Changes link

Other Changes and Fixes link

Ren'Py 6.99.11 link

New In-Game GUI link

Improved Platform Support link

Style Prefix Support link

Style Properties link

Translate and Style Statement Order Changes link

Local Labels link

Transforms link

Translations link

Other link

Ren'Py 6.99.10 link

Fixes link

Translation link

Other Changes link

Ren'Py 6.99.9 link

Bug Fixes link

Other link

Ren'Py 6.99.8 link

Tags, Layers, and Transforms link

Easing Functions link

Side Images link

PushMove Transitions link

Other link

Ren'Py 6.99.7 link

Dynamic Images link

Define Improvements link

Android/iOS link

Other link

Ren'Py 6.99.6 link

HighDPI/Retina link

Gamepad link

Backups link

Other Improvements link

Ren'Py 6.99.5 link

Startup link

iOS link

Other Improvements link

Ren'Py 6.99.4 link

Fixes link

Ren'Py 6.99.3 link