diff --git a/README.md b/README.md index 0c85967..bd11da5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Godot addon that lets you rapidly take screenshots. Supports taking bursts in mu

## Installation -- Download the latest release and paste it into your Godot project +- Download the addon from [AssetLib](https://godotengine.org/asset-library/asset/4405) within the Godot Editor - Enable the addon in the Project Settings ## Usage @@ -22,11 +22,12 @@ Godot addon that lets you rapidly take screenshots. Supports taking bursts in mu ## Configuration Configure the addon from its Debugger panel. Settings are stored at `settings.cfg`. ### Shutter - -- **Pauses game**: Pause execution while taking screenshots. Useful for ensuring consistency across burst captures. - **Show shutter**: Toggle shutter visibility +- **Only run in Editor**: If the game is running outside the editor (`OS.has_feature("editor")` is `false`), hide the shutter and disable input processing +- **Pauses game**: Pause execution while taking screenshots. Useful for ensuring consistency across burst captures. + - **Shutter sounds**: Whether to play shutter sound effect -- **Input Action**: Configure keyboard shortcut +- **Input Action**: Set an Input Action to trigger a screenshot ### Resolution - Specify one or more target sizes. The addon calls `DisplayServer.window_set_size()` for each size before capturing. @@ -37,7 +38,7 @@ Configure the addon from its Debugger panel. Settings are stored at `settings.cf ### Save - **Path**: Screenshot save location (default: `user://screenshots`) - **Formats**: PNG, JPG, WEBP -- **Use subfolders**: Organize bursts into folders with this structure `$PROJECTNAME_$TIMESTAMP/$LOCALE/$RESOLUTION` +- **Use subfolders**: Organize bursts into folders with this structure `projectname_timestamp/locale/resolution` ## API Accessible through the `Screenshots` singleton. @@ -64,6 +65,13 @@ burst_ended ``` Fires after the burst is completed. Use it to unhide debug UI elements. +#### Example +```gdscript +func _ready() -> void: + Screenshots.burst_starting.connect(_hide_debug_ui) + Screenshots.burst_ended.connect(_show_debug_ui) +``` + ## Version Compatibility Tested on Godot 4.5 (Linux and macOS) @@ -72,6 +80,7 @@ For bugs and feature requests, please open an issue. Additional questions? Email ## Credits - Developed by [Davide Di Staso](http://www.pumpkintree.games) +- Uses [Directory Watcher](https://github.com/KoBeWi/Godot-Directory-Watcher) by Tomek - Screenshots addon icon based on modified Godot Editor icons - Shutter icon by [Bootstrap](https://github.com/twbs/icons) - Shutter sound effect by [ALEXIS_GAMING_CAM](https://pixabay.com/users/alexis_gaming_cam-50011695/) from [Pixabay](https://pixabay.com/)