Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #15

Merged
merged 1 commit into from
Jun 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 50 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,50 +11,53 @@ You can also define properties for your script that allow you to use user input

# Usage
Go to the Sidebar. A tab named "Script To Button" is now available.
> ## "Controls" Panel
> Here are control buttons for the Add-on located.
> > #### Add
> > Add a new Button to the "Buttons" Panel.
> > <br> When the button is pressed a popup will appear with options to name your button and to selected the script from Texteditor which will be linked to the Button.
>
> > #### Remove
> > Remove the selected Button from the "Buttons" Panel.
> > <br> When the button is pressed a popup will appear with the options to delete the button from file and also the linked script.
>
> > #### Load
> > Give you the option to load all buttons from the Disk or from the Texteditor.
> > When the button is pressed a popup will appear with a switch to decide where to load from.
> > ##### Load from Disk
> > A warning message is shown and when executed all buttons in Blender will be deleted and loaded from the disk.
> > ##### Load from Texteditor
> > All Texts are represented with a checkbox to decide which to load.
> > <br> If the Button exist it will be reloaded otherwise a popup will appear with the option to add or skip this script.
>
> > #### Save
> > (only available when Autostart is off)
> > <br> Save all buttons to the disk.
>
> > #### Load Button
> > Loads the selected Button into the Texteditor.
>
> > #### Reload
> > Reload the linked script of the selected button.
> > <br> If Autosave is active the button is also saved on the disk.
>
> > #### Rename
> > Give you the option to rename the selected button.
> > When the button is pressed a popup appear with a text field to put in the new Name.
>
> > #### Export
> > Opens an export window to export your buttons as .py files or one .zip file.
> > <br> On the right side of the export window are the option to choose in which format you want export the scripts. Under this option, all buttons are listed with a checkbox to decide which ones to export.
>
> > #### Import
> > Opens an import window to import .py files or .zip files .
> > <br> You can select multiple .py and .zip files to import them all at once.

> ## "Buttons" Panel
> All your buttons are displayed here

> ## "Properties" Panel
> All registered properties of the selected button are displayed here

## "Controls" Panel
Here are control buttons for the Add-on located.

#### Add
Add a new Button to the "Buttons" Panel.
<br> When the button is pressed a popup will appear with options to name your button and to selected the script from Texteditor which will be linked to the Button.

#### Remove
Remove the selected Button from the "Buttons" Panel.
<br> When the button is pressed a popup will appear with the options to delete the button from file and also the linked script.

#### Load
Give you the option to load all buttons from the Disk or from the Texteditor.
When the button is pressed a popup will appear with a switch to decide where to load from.
##### Load from Disk
A warning message is shown and when executed all buttons in Blender will be deleted and loaded from the disk.
##### Load from Texteditor
All Texts are represented with a checkbox to decide which to load.
<br> If the Button exist it will be reloaded otherwise a popup will appear with the option to add or skip this script.

#### Save
(only available when Autostart is off)
<br> Save all buttons to the disk.

#### Load Button
Loads the selected Button into the Texteditor.

#### Reload
Reload the linked script of the selected button.
<br> If Autosave is active the button is also saved on the disk.

#### Rename
Give you the option to rename the selected button.
When the button is pressed a popup appear with a text field to put in the new Name.

#### Export
Opens an export window to export your buttons as .py files or one .zip file.
<br> On the right side of the export window are the option to choose in which format you want export the scripts. Under this option, all buttons are listed with a checkbox to decide which ones to export.

#### Import
Opens an import window to import .py files or .zip files .
<br> You can select multiple .py and .zip files to import them all at once.

## "Buttons" Panel
All your buttons are displayed here

## "Properties" Panel
All registered properties of the selected button are displayed here