Skip to content
This repository has been archived by the owner on Dec 18, 2021. It is now read-only.

Commit

Permalink
add export page
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremi360 committed Apr 14, 2021
1 parent 4918c09 commit cde723b
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 4 deletions.
1 change: 1 addition & 0 deletions source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ topics/text.md
topics/menus.md
topics/variables_and_conditions.md
topics/changing_scenes.md
topics/export.md
```

```{toctree}
Expand Down
52 changes: 52 additions & 0 deletions source/topics/export.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# How To Export Project

## Project Settings

Before Export some Project Settings need to be changed:

![](project_setup/project-settings-saves.png)

- _rakugo/saves/test_mode_ - 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://_

## Export menu

After many attempts at different export workflows, the current one has proven to work the best.
At the time of this writing, not all platforms are supported yet, but the supported platforms continue to grow.

To open the export menu, click the **Export** button:

![](https://docs.godotengine.org/en/3.0/_images/export.png)

The export menu will open, however it will be completely empty.

![](https://docs.godotengine.org/en/3.0/_images/export_dialog.png)

That is because we need to add an export preset.
To do that click the **Add..** button at the top of the export menu.
This will open a drop down list of platforms to choose from for an export preset.

![](https://docs.godotengine.org/en/3.0/_images/export_preset.png)

The default options are often enough to export, so tweaking them is not necessary, but provide extra control. However, many platforms require additional tools (SDKs) to be installed to be able to export. Additionally, Godot needs export templates installed to create packages. The export menu will complain when something is missing and will not allow the user to export for that platform until they resolve it:

![](https://docs.godotengine.org/en/3.0/_images/export_error.png)

At that time, the user is expected to come back to the documentation and follow instructions on how to properly set up that platform.

## Export templates

Apart from setting up the platform, the export templates must be installed to be able to export projects. They can be obtained as a .tpz (a renamed .zip) file from the [download page of the website](https://www.godotengine.org/download).

Once downloaded, they can be installed using the “Install Export Templates” option in the editor:

![](https://docs.godotengine.org/en/3.0/_images/exptemp.png)

## Export Settings

We need add _\*.json_ files, for emojis to work,
![](https://user-images.githubusercontent.com/1294815/114680296-4d2f1900-9d0d-11eb-95e6-9122ff91427f.png)

change script export mode in the export settings from compiled to text
![](https://user-images.githubusercontent.com/1294815/114680556-9bdcb300-9d0d-11eb-8b37-ab1f3a991cad.png)
8 changes: 4 additions & 4 deletions source/topics/project_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ There are some obsolete options that will be fully removed in a future update.

- _rakugo/game/scenes/scene_links_ - this setting tells rakugo where is [SceneLinks resource, more about it here](changing_scenes.md). 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
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

Expand Down Expand Up @@ -98,10 +98,10 @@ Character used when `say()` is called with `character_tag = null`.

![](project_setup/project-settings-saves.png)

- _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/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 from _user://_ instead of _res://_
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
Expand Down

0 comments on commit cde723b

Please sign in to comment.