Project Setup

Create Rakugo Project

  1. Godot Engine needs to be downloaded and installed.

  2. Download Rakugo from official sources.

  3. Open Godot and use the Import button to your right, then browse your files to find the Rakugo ZIP.

Warning

Godot will load the Rakugo template, but there is a known, easy to fix issue. Due to how Godot 3.x currently loads add-ons, it will not start Rakugo correctly the first time. Simply close the project or restart Godot then reopen to load Rakugo correctly. The shortcut for closing a project is Ctrl + Shift + Q.

Project Structure

Note

The FileSystem tab is your main hub, should only use this tab to change names or move files for your project.

  • addons/Rakugo/ - the core code of Rakugo. You should leave this alone unless you know what you’re doing.

  • fonts - fonts assets used by GUI for text displays.

  • game - Most of your game code and assets should be here.

  • graphics - Graphical assets used by Rakugo

  • gui - Your highly customizeable GUI. It can be used for whatever GUI a creator can think of.

  • themes - Obsolete GUI themes from older Rakugo versions that will be removed or replaced in future versions.

Rakugo Project Settings

To change game settings for your project, select Project > Project Settings

Here is a new Rakugo category for the add-on content. There are some obsolete options that will be fully removed in a future update.

Obsolete Settings

  • rakugo/game/info/credits

  • rakugo/editor/debug

  • rakugo/default/gui/theme

Game Settings

  • rakugo/game/info/version - current version of your game

  • rakugo/game/text/markup - markup langue used in dialogue more markup it here

  • rakugo/game/scenes/scene_links - this setting tells rakugo where is SceneLinks resource, more about it here. This can be use for dlcs and mods.

  • rakugo/game/scenes/force_reload - should rakugo force reload scene on jump between dialogue events, can fix some bugs if for example you have all game in one scene, like our The Question demo

  • rakugo/game/store/rollback_steps - how many rollback steps can be done

  • rakugo/game/store/history_length - how long history log is displayed

Default Functions Arguments Settings

Narrator

Character used when say() is called with character_tag = null.

  • rakugo/default/narrator/name

  • rakugo/default/narrator/color

Delays

  • rakugo/default/delays/typing_effect_delay - time between typing next letter when typing_effect = true

  • rakugo/default/delays/typing_effect_punctuation_factor - how long wait after punctuation before continue typing effect

  • rakugo/default/delays/auto_mode_delay - how long does the step take on auto mode

  • rakugo/default/delays/skip_delay - how long does the step take on skip mode

Statements

  • rakugo/default/statements/default_say_parameters - default additional parameters for say() statement

  • rakugo/default/statements/default_ask_parameters - default additional parameters for ask() statement

  • rakugo/default/statements/default_show_parameters - default additional parameters for show() statement

Save Settings

  • rakugo/saves/test_mode - if set true, save files will be saved as text files in your project folder for ease of testing. Set it to false before export.

  • rakugo/saves/save_folder - it is the path for the project’s save folder. Before exporting, change it to start to user:// instead of res://

  • rakugo/saves/save_screen_layout - how to displays saves in pause menu, there are 2 build modes for this:

    • save_pages - use grid and pages, similar to Ren’Py way of displaying saves

    • save_list - use vertical list of saves, similar to RPGMaker way of displaying saves