Parcourir la source

:memo: Explain how to use processing management

DricomDragon il y a 1 semaine
Parent
commit
82926b5159
1 fichiers modifiés avec 11 ajouts et 2 suppressions
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -32,7 +32,7 @@ If you want to target a specific slide you see, juste click on it with your mous
 
 ## How to use
 
-This repository contains a [minimalist example](godot/example/) made with Godot 4.0.2. You can clone this project and open the `godot` folder with Godot 4+.
+This repository contains a [minimalist example](godot/example/) made with Godot 4. You can clone this project and open the `godot` folder with Godot 4+.
 
 ### Basics
 
@@ -56,7 +56,7 @@ Instantiate the Focus node, playing the role of a custom Camera2D.
 
 #### 4. Instantiate a Show
 
-Instantiate the Show node, that must be next to the Focus node that will be auto-detected.
+Instantiate the Show node, that must be a sibling of the Focus node to be auto-detected.
 
 #### 5. Create your own Slides by creating Scene based on Slide node
 
@@ -94,6 +94,15 @@ 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.
 
+#### Processing management
+
+One of the most useful abilities of the Godot Slideshow Plugin is to showcase Godot scenes, like game samples or engine features.
+
+By default, to prevent side-effects and overcharge your computer resources, Slide nodes override the process state of their children. You can adjust these settings in the *Processing management* section :
+
+- [x] Start when enabled : when the current slide is focused, set the process mode of every child to `PROCESS_MODE_PAUSABLE` ; otherwise, do not alter the process mode
+- [ ] Keep when disabled : keep the process state when the slideshow starts or when the focus go to another slide ; otherwise, set process mode to every child to `PROCESS_MODE_DISABLED`
+
 #### 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.