What is Ren'Py: An Overview of the Visual Novels Technology and a Tutorial on Developing Your Own Game with the Engine / ITech content

Contents:

• What is Ren’Py
• Is it necessary to learn Python to make games with Ren’Py?
• The downside of Ren’Py
• Installing and using Ren’Py
• Getting Started
• Printing Text
• Developing a Visual Novel
• Preparing Assets
• Working on the Introduction
• Creating the First choice
• Adding NPC images
• Finishing the ending
• Results

Ren’Py is one of the most popular tools for creating interactive stories and visual novels. If you're looking to develop your own visual novel but are intimidated by the complexities of learning programming languages ​​and game engines, you might want to consider Ren'Py. Ren'Py offers an intuitive interface and simple structure, making it accessible even for beginners. With Ren'Py, you can easily bring your ideas to life and create a captivating story that will engage players.

In this article, the Skillbox Media "GameDev" editorial team takes a detailed look at the key features and core functions of the builder, using their own interactive story as an example. We'll analyze how this tool enables the creation of engaging content and the benefits it offers users.

We invite you to subscribe to our "Checkpoint" Telegram channel, where we publish valuable resources for aspiring developers. In our channel, you'll find articles on game design, helpful software guides, and interviews with developers who have already released their games. Join us and expand your knowledge of game development.

What is Ren'Py

Ren'Py is a free game engine designed for creating visual novels. With it, you can develop a captivating interactive story using 2D graphics, sound effects, and music, as well as integrate videos. Ren'Py offers users a variety of tools for writing scripts, creating characters, and managing gameplay, making it an ideal choice for both beginners and experienced developers. Use Ren'Py to realize your creative ideas in the visual novel format.

The builder is implemented in Python and offers extensive capabilities for creating interactive projects. It supports the integration of multiple dialogs, non-linear branches, and a parameter system typical of life simulators. In addition, users can implement mini-games. Each project automatically includes a main menu, a save system, and a built-in dialog history viewer, greatly simplifying gameplay management. Using this builder allows developers to create unique and engaging scenarios, captivating users.

The finished game can be released on various PC operating systems, including Windows, Linux, and macOS, as well as mobile devices running iOS and Android. Ren’Py visual novel development technology has been around for nearly 20 years and continues to evolve. The current version of Ren’Py is 8.1.3, released on September 18, 2023, offering new features and improvements for game developers.

Is it necessary to learn Python to make games with Ren’Py?

Beginners, when opening a visual novel script, may feel confused by the large number of lines of code and unfamiliar commands. However, developing a simple game on the Ren’Py platform does not require in-depth knowledge of Python. Most functions and commands are available in the official documentation, which greatly simplifies the process. In practice, programming often boils down to simple actions such as copying and pasting with a few parameter changes. This makes creating visual novels accessible even for those just starting out in game development.

With advanced knowledge of Python, you can significantly enhance your project by adding various features—from effects such as screen shake to complex character interaction systems. It is also possible to integrate a full-fledged inventory. Implementing these extensions often doesn't require the help of a professional programmer, as Ren'Py communities present on many social networks, including VKontakte, offer ready-made solutions and helpful tips.

The Downside of Ren'Py

Working with Ren'Py has a truly low entry barrier, making it accessible to beginning visual novel developers. However, despite this, the number of well-known projects using this engine remains limited. The reasons for this can range from a lack of original ideas and quality content to the difficulty of marketing and promoting games. To achieve success, developers must not only master Ren'Py's tools but also focus on creating a unique story, developing characters, and an effective promotional strategy for their project. Many players are only aware of popular visual novels such as Doki Doki Literature Club!, Everlasting Summer, Tiny Bunny, Katawa Shoujo, and Milk Inside a Bag of Milk. However, there are many other games on the market, created by both experienced and novice developers. These projects are generally less well-known and are most often discussed in narrow subject circles. However, they offer unique experiences and interesting stories that can attract the attention of a wider audience. Exploring lesser-known visual novels can open up new horizons and allow players to enjoy original stories and creative approaches to gameplay.

Ren'Py is a simple tool for creating visual novels, but this convenience has its drawbacks. Many novice developers, realizing the platform's accessibility for commercial projects, often neglect the quality of in-game content, including graphics and programming. As a result, forums regularly discuss how most Ren'Py games suffer from numerous bugs, as well as the fact that truly high-quality projects using this engine are extremely rare. To successfully create a game, it's important to focus not only on the tool's accessibility but also on the quality of the content, which will help you stand out from the competition and attract an audience.

Many visual novels emphasize "mature" content, which creates a negative image of the genre. Specialized media often voice opinions that many players don't perceive visual novels as full-fledged games. However, perhaps your creation using this engine will be a breakthrough and change established stereotypes.

Let's explore the practical application of constructor functions.

Ren'Py Installation and Interface

The authors of Ren'Py strongly recommend installing the latest version of the engine, in particular version 8, as it provides support for Python 3. On the client download page, select your preferred archive format and unzip it to your hard drive. Then run renpy.exe, select the application language, and familiarize yourself with the launcher interface. This will allow you to quickly start working with the engine and create visual novels.

This application performs all the necessary actions with projects developed on the platform.

On the left is the Projects menu. Ren’Py has two default templates: Tutorial and The Question. You can select either template and click Launch Project. The Tutorial template offers a character who introduces the user to the engine’s basic features. The Question project Illustrates a simple model of a non-linear romantic story, which allows you to better understand the capabilities of Ren'Py for creating interactive stories.

When you select a project in the Ren'Py launcher, a series of menus appears on the right. Let's take a closer look at them.

"Open Directory" allows the user to launch File Explorer to view the contents of the selected folder. This feature simplifies access to files and subfolders, allowing you to quickly find the information you need. Opening a folder is intuitive, making interaction with the file system more convenient and efficient. Users can easily manage their documents, move files, and organize them into categories, which contributes to a better organization of the workspace.

• game - contains all game content;
• base - the main folder with the game client;
• images - content with the visual component of the game (backgrounds, character avatars, videos, and so on);
• gui (an abbreviation for graphical user interface) - another folder with images, but this time intended for the game interface;
• audio - sounds and music.

Ren'Py automatically creates all the necessary folders when creating a new project. Therefore, if you open any visual novel project created with this engine, you will see similar directories. This simplifies file organization and allows developers to easily navigate the project structure.

The "Edit File" section allows you to view all files with the .rpy extension, which contain the code for various game elements. When you first launch Ren'Py and navigate to this section, the builder will offer you the choice of one of several script editors. This allows developers to conveniently edit and customize game scripts, which is an important step in creating interactive content. Choosing the right editor can significantly simplify the process of working with code and increase development efficiency.

The developers recommend using Visual Studio Code as their preferred text editor. This engine will automatically install the selected editor after installation. Afterwards, click on the name of the script editor to specify it in the settings. This will optimize your workflow and improve interaction with the code.

Choosing a text editor is an important step when working with .rpy files. Opening such a file automatically launches the selected script editing application. In this case, Visual Studio Code is used, which provides a user-friendly interface and powerful development tools.

In The Project Actions section of the interface provides a variety of tools for effectively working with project code. This section offers users access to key functions that facilitate project management and optimize workflows.

• Navigate Script. Edit and organize existing segments.
• Check Script. Check the code for possible errors using the Lint tool. It is worth noting that Lint automatically checks the project for critical errors at startup.
• Change/Update GUI. Overwrites GUI settings.
• Delete Persistent. Delete duplicate data. For example, do not show the history prologue every time at startup.
• Force Recompile. Forced code recompilation.

On the right is a list of options required to complete the project.

• Build distributions. A window opens where you can select a desktop platform and generate a ZIP archive of the game build, which you can run manually.
• Android, iOS, Web (Beta). Creates a port for the specified platforms. Requires installation of additional programs for compilation.
• Generate Translations. A function for creating localization if the developer wants to release the game in several languages.
• Extract Dialogue. Export dialogues from the game in TAB or TXT format.

The launcher settings, located in the lower right corner, provide access to the main editor functions. Here you can select a folder for the project, specify a text editor for scripts, and configure various navigation and information display functions in the launcher. There are also options for changing the theme, installing libraries, including Steam support, and performing basic project operations. These settings allow you to optimize your workflow and tailor the launcher to your individual needs.

Once you've mastered the basic elements of the Ren'Py client interface, you can move on to learning its fundamentals.

First Steps

First, you need to create a new project in Ren'Py. To do this, click the "+ Create New Project" button. The builder will notify you that the project language will match the default launcher settings. In our case, Russian is selected, but you can also use Latin for writing lines.

Click the "Continue" button. Then enter a name for your project and specify its resolution. In this example, we've selected a universal setting for a desktop application with a resolution of 1920x1080, which ensures optimal display quality. Ren'Py will then prompt you to select a color scheme for the game's GUI. You'll be able to see the changes in real time. The primary palette uses dark or gray tones, while a secondary color highlights key interface elements. You can change the color scheme at any time in the settings menu by selecting "Change/Update GUI." In this same window, you can customize the screen mode and text display speed, allowing you to tailor the interface to user preferences.

If the user didn't specify a path for the future build in the launcher settings before creating a project, the engine will prompt them to select a directory in which to store the project files. Choosing the correct folder for storing project files is important for simplifying further work and organizing the project structure.

After completing the preliminary settings, a new project will become available in the launcher. You can open it by selecting the "Launch Project" option. The generated main menu will load, from which a new game begins. After loading, the dummy character will say a few lines, and the game will end.

Now, with the foundation for the upcoming project, We can significantly adapt the content to suit our purposes.

Text Output

To edit your project in Ren'Py, select its name in the launcher and open the script.rpy file in the "Edit File" section. This file contains the main code for your project. Note that lines beginning with the # symbol are comments. You can delete them or leave them for convenience, as they do not affect the functionality of the project.

Delete All data that comes after the label start of the game segment and focus on creating a simple narrative element on a dark screen. This technique can be effectively used at the beginning of the game or other key moments in the story, for example, when the protagonist enters a dark room and does not yet turn on the lights. This creates an atmosphere of tension and anticipation, helping players immerse themselves in the story.

To display text on a dark screen in Visual Studio Code, you need to enclose the narrative strings in quotation marks. These quotation marks are automatically added when you press the “ key. When writing text, it is important to remember that the entire string will be displayed on the screen at once. If a fragment is too long, break it into logical parts, as if the character were speaking the text in real life. Each new phrase should begin on a new line, while keeping in mind the syntax - add a Tab at the beginning of a new line. After you finish editing, save your changes and preview the result.

To indicate the person from whom the story is being told, it is necessary to put the narrator's name in quotation marks before the corresponding phrase. This will help the reader better understand the point of view and context of the presentation. Proper formatting of the narrator's name contributes to clarity and improves the comprehension of the text.

Keep in mind that by default the designer uses the color scheme specified in the GUI settings. We'll create a script that will define a color for a specific character, based on the pattern already implemented for the placeholder character. In doing so, we'll replace the value of "Eileen" with "Author".

• The define command specifies what should be defined.
• au is the variable we defined for a specific character (it can be any combination of letters).
• Character is the class that defines the character.
• The brackets contain the character's characteristics. In this case, the name displayed in the game and the color (the latter can be easily selected by hovering over the icon in Visual Studio Code).

Now we can omit the quotation marks before this character's lines, which simplifies the text and makes it more readable. This allows us to focus on the content of the dialogue and gives it a natural flow. Using this approach improves the perception of the text and makes it more convenient for the reader.

It should be noted that this is not an exhaustive list of manipulations available for work With in-game text. For more information on dialogue formatting, please refer to the official documentation. It is important to familiarize yourself with the various options to effectively use text elements in the game.

Note: This text contains important information that may be helpful in understanding the topic. Please pay attention to the key points to better understand the material presented. We strive to provide relevant and useful information that will help you understand the issues related to the topic. Please take the time to review the information carefully.

To set off a word or phrase with quotation marks in a line, you must add the \ symbol before the quotation marks, as shown in the example below. This will display the text correctly and avoid errors in the interpretation of quotation marks. Using this method is relevant for the correct formatting of dialogue and quotes in HTML content.

Development of a visual novel

We are starting to create a first-person visual novel. This novel will feature a mini-introduction, several scenes with branching plot points, and multiple characters in addition to the narrator. This will create an interactive and engaging experience for the player, immersing them in the story and allowing them to make decisions that influence the course of events. The focus will be on dynamic character interactions and creating a tense atmosphere, which will capture the audience's attention and ensure a high level of engagement.

When creating a visual novel, having a completed script, key assets such as background images, characters, sounds, and music, and a prototype greatly simplifies the process. Creating a prototype in Twine allows you to better understand how to structure the text in scenes and what media to use for its visual and auditory accompaniment. Detailed information about Twine and its capabilities can be found in our dedicated article. Creating a visual novel using ready-made assets and tools will improve the quality of the project and speed up its implementation.

Preparing Assets

First, let's move the assets created for the upcoming project to the appropriate directories. In the "Open Directory" section, open the desired folders and move the finished content into them. Place all sound and music files in the audio folder, and images, such as backgrounds and avatars, in the images folder. This will organize the project structure and simplify access to the necessary resources. Proper asset organization is an important step in the development process, as it promotes more efficient work and reduces the likelihood of errors.

To prevent confusion when creating scripts and selecting assets for scenes, it is important to use full descriptions of the image contents in file names. The established naming hierarchy should be followed. Examples of proper asset names can be found in the Ren'Py tutorial projects mentioned earlier. This will help simplify file organization and improve content interaction.

In the images folder of the Question project, each image has a unique tag and attributes, making them easier to use and identify. For example, background images use a generic tag (bg - background) followed by the location name. Thus, files are named bg club, bg lecturehall, bg meadow, and so on. The names of the heroine assets include the character's name, the color of her clothing (since she changes appearances throughout the story), and her emotional state: standard (sylvie blue normal), giggling (sylvie blue giggle), surprised (sylvie blue surprised), and other emotions. This approach to image naming not only improves file organization but also contributes to better SEO, as it facilitates indexing and searching of content.

Characters should be represented only by files with a transparent background in PNG or WEBP formats. If you have a large number of characters, it is recommended to organize their avatars in separate subdirectories, but it is important that all files remain in the images folder. Hyperlinks are not required, as the designer will automatically determine the path to all the necessary files.

If you do not yet have your own assets, you can download placeholders from the itch.io platform. This resource offers a wide selection of free and shareware character avatars, backgrounds, and even music samples. This is a great solution for developers looking for high-quality graphic and sound assets for their projects without significant costs.

In this example, we will look at the use of renders of 3D models and scenes. The main musical accompaniment will be the composition "Leaving The World Behind" by Koala Vert, licensed under CC BY 4.0. This allows us to create an atmosphere for the visualization, drawing attention to the details and features of 3D objects. Renders of 3D models serve as an important tool in design and animation, allowing you to demonstrate ideas and concepts in high quality.

Developing the Introduction

After the voiceover, an image with background design and musical accompaniment appears on a black background. This can be designed as follows.

At this stage, we will review the obtained results and conduct their analysis.

• The lines separated by quotation marks are our introduction.
• Play is a command for playing a media file, in this case a musical composition (music) from the audio folder. The file name must be specified in quotation marks and include the extension.
• Scene — starts the scene, i.e., loads the background; in this example, this is the file "bg road." No image file extension is required.
• With — accompaniment. In this case, "fade" is a smooth loading of the image lasting 0.5 seconds. This option is optional, but it makes the scene change more effective.

Starting the project in its current state will cause it to terminate immediately after the scene begins. To avoid this and make it more interesting, it is recommended to add at least one line of narration. The result will be more complete and eye-catching content.

Creating the First Choice

With just a few lines of code, we've already created the game's atmosphere. Now comes the most interesting stage — the global story choice, which is formed using the menu command. Visual Studio Code has a feature that allows you to quickly generate all the necessary options. If you start typing the word menu, a pop-up menu will appear from which you can select an item labeled Choice Menu. This tool significantly simplifies the development process and allows you to focus on creating an engaging story for players.

The editor will automatically create the following lines of code:

• optional_name — the name of the choice, fill it in at your discretion.
• «Say Statement» — enter a phrase (or more than one) that will serve as a prerequisite for the choice. In our case, we can add the question "Where should I go?"
• "Choice 1" and "Choice 2" are the names of the choices, for example "Yes."/"No."

After each choice line, it is necessary to indicate the actions that will lead to a certain outcome. For example, if the narrator remains on the current path, the game will end. If the path is chosen, the next scene will load. This helps create an interactive and engaging experience for the player, ensuring an exciting development of the plot and involvement in the decision-making process. Each choice should have an impact on the further development of events, which will increase the interest and involvement of the audience.

To move the player to a specific stage, use the jump keyword and specify the checkpoint name. This allows the player to advance to the next stage after making a decision. This approach ensures a smooth transition between different parts of the game and improves gameplay, allowing players to progress more quickly through the scenario.

Let's take stock of everything we've learned so far. In the collage below, you can see how the lines of code listed above appear in gameplay.

Now we need to describe the consequences of each choice in order. To do this, after the lines where the choice occurs, we will specify new checkpoints for the program (label), which will create new segments of the game. This will allow the player to better understand the impact of their decisions and improve interaction with the game, making it more engaging and dynamic.

Earlier, we came to the conclusion that if the narrator does not deviate from the chosen path, the game will end. However, if he decides to continue along the path, a new scene will begin, and the narrative will continue to develop. Below is the code demonstrating this process.

When the game starts and the second option with the path is selected, a new scene will open, specifically designed for this path. However, since this segment does not yet have an ending, after completing it, playback of the previously unselected segment will begin. At the end of the script there is a return command, which always ends the game if it is in the final label segment. This creates a unique experience for players, allowing them to explore different scenarios, but also highlights the need for some refinement to the game logic for a smoother conclusion.

Adding NPC Images

Let's continue developing the concept of the path sequence and integrate the character into the plot. To add an image of the character, use the show command on a new line. By default, the character is displayed in the center of the screen, but can be moved to any part of the screen, for example, at left or at right. In the Visual Studio Code editor, all available options are automatically highlighted after typing the word at. This makes it easy to adjust the character's position and create more dynamic scenes.

During dialogue, when the character displays different emotions, we add a new image before each line associated with a certain reaction. Below is an example illustrating how this is implemented in code and in gameplay. The letter «o» before the start of the line indicates the character variable set as described in the previous chapter.

Refining the ending

We will formulate the final dilemma by analogy with the initial choice in the game. However, given that the story is coming to an end, it is necessary to add another ending option, which will be relevant if the player gives a positive answer.

If the character makes a negative decision, we again describe the situation in which he continues moving along the road, without deviating from the intended path. This fragment will represent an alternative bad ending, emphasizing the consequences of the hero's choice.

The screenshot shows the distribution of non-linear segments. This script uses {b}{/b} formatting, which allows you to highlight text in bold. This formatting can be effectively used to create tooltips and emphasize keywords.

Finally, let's look at how all the plot forks in the game are presented. These forks in the road play a key role in creating a unique gameplay experience and allow players to make decisions that influence the course of events. By exploring different paths, players can gain a deeper understanding of the storylines and characters, making the game more engaging and multifaceted. Each fork in the road opens up new possibilities and highlights the importance of choice in gameplay.

Once the project is complete, it can be compiled into a build using the Build Distributions feature. This process will create an archive containing the application that can be run independently of the launcher. Compiling the project into a distribution ensures convenient deployment and use of the application on various devices.

Summary

Using simple Python syntax, we developed a short story on the Ren’Py platform. This project includes sound and music, unique graphic assets, and interesting plot forks that allow players to make decisions and influence the course of events.

This mini-game can be improved both in terms of functionality and code. The final result represents only a small portion of the Ren'Py engine's capabilities. For example, you can integrate the illusion of GIF animations using a script that displays images frame by frame. It's also worth improving the interface, especially the game's main menu, and adding mini-portraits of characters to dialogue. If the plot is more complex, you can use flags—variables that allow you to change the course of events and the characters' attitudes toward the player by tracking certain values ​​in the code. To finally determine whether this engine is right for you, it's important to consider its pros and cons.

• Easy to learn. This includes those not only unfamiliar with Python but also unfamiliar with the basics of programming in general. This technology gives people without technical skills the opportunity to create their own game.
• A large number of reference materials. There are many engine tutorials online, including video ones.
• Ability to publish the game on desktop and mobile platforms.

• Limited genre range. Ren'Py is primarily designed for visual novels, point-and-click games, and life simulators.
• The further the project goes beyond the standard visual novel, the more in-depth Python learning will be required.
• Huge competition in the visual novel market. Also, don't forget that most players tend to devalue this genre. It will take a lot of effort to prove otherwise.

• Official Ren'Py documentation. A huge database of all engine functions. You may have difficulty finding a specific function.
• Lemma Soft Forum. A community of visual novel developers where you can find a lot of useful information. Since the forum has been around for quite some time, some Ren'Py scripting solutions described in the threads were published several years ago and are now outdated. Therefore, when reading, please pay attention to the publication date. For more up-to-date information, it is advisable to join the forum's Discord channel.
• Feniks Development. A look at Ren'Py from a programmer's perspective. This resource contains a wealth of information on the engine, including a glossary, useful tools, and tutorials.
• A playlist with tutorials on creating a visual novel for beginners from the YouTube channel Zeil Learnings. The channel also contains a lot of other useful information on Ren'Py, including for advanced users. Feniks Development notes that some tutorials contain code errors, but they are not critical.

Ren'Py is a powerful tool created to simplify the process of visualizing existing stories, rather than writing them from scratch. Visual novels are complex works with a multi-layered structure, and their text length can exceed 100,000 words. Effectively conveying a compelling narrative using both writing and still images requires specialized skills and experience. When using Ren'Py, it's important to remember that the success of a visual novel depends not only on the plot, but also on the high-quality implementation of all elements, including graphics, sound, and interface.