Ver código fonte

:memo: Explain how to use the export feature

DricomDragon 2 meses atrás
pai
commit
f700017734
1 arquivos alterados com 22 adições e 0 exclusões
  1. 22 0
      README.md

+ 22 - 0
README.md

@@ -94,6 +94,28 @@ To reveal slides on focus, check the `hide slides` in the Show. If you want some
 
 You can create your own actions, and give them to the Show node via the `input setup` section in the inspector.
 
+#### Export your slides
+
+The plugin leverages the [Godot Movie Maker](https://docs.godotengine.org/en/stable/tutorials/animation/creating_movies.html) to easily export every slides to png files.
+
+This feature can be useful when you need to share your work without the hassle to download your project and set up Godot. The exported slides can be used as a backup, or can be cliped into a video for instance.
+
+1. Set up your export path in the _Project settings > Editor > Movie maker_ (make sure the folder exists, and specify png), e.g. `../dist/export/slide.png` ;
+2. Enable the movie mode ;
+3. Run the project : the `Show` will quickly review every slide, and quit when the last one is reached ;
+4. It's already done : your slides are available in your export folder, with one *png* file for each slide.
+
+Note : the resolution of your exported slides are related to the resolution set up in your project.
+
+Warning : pay attention to the window resolution, especially if you are using a tiling windows manager!
+
+The export automation is enabled with two toggles in the `Show` node, in the _Export_ section :
+
+- [x] One Slide per Frame : automatically go to next slide at each frame ;
+- [x] Quit after last slide : automatically quit the game after the last slide is reached.
+
+Note : the export settings are effective only when the Movie Maker mode is enabled.
+
 ## License
 
 This plugin is free software licensed under the [MIT license](https://mit-license.org/), the same license used by the Godot engine itself.