File indexing completed on 2024-06-09 04:28:25

0001 <?xml version="1.0" encoding="utf-8"?>
0002 <!DOCTYPE html>
0003 
0004 <html xmlns="http://www.w3.org/1999/xhtml">
0005 <!--BBD's Krita Script Starter, Feb 2018 -->
0006 <head><title>BBD's Krita Script Starter</title>
0007 </head>
0008 <body>
0009 <h3>BBD's Krita Script Starter</h3>
0010 This script sets up the various files that Krita expects to see 
0011 when it runs a script. That is:
0012 <ul><li>the .desktop meta data file</li>
0013 <li>the package directory</li>
0014 <li>the __init__.py file</li>
0015 <li>the main python file for your package</li>
0016 <li>the Manual.html file for your documentation</li>
0017 </ul>
0018 
0019 It will correctly name your package, do relevant imports, 
0020 create a class of the relevant type (ie Extension v Docker) 
0021 and name the class based on the name you choose for your script.
0022 <p>
0023 <h3>Usage</h3>
0024 When you run the script it will present a dialog box. Enter the name 
0025 of your script in the entry box provided and choose whether you 
0026 want the script to be an Extension (added to the scripts menu) 
0027 or a Docker (available to be opened as a docker).  Type in 
0028 a comment for the script (this is displayed in the Krita dialog
0029 when enabling scripts) and, if you want, the text of how 
0030 you want your script to appear in the menu. 
0031 You can choose to have your script automatically enabled by 
0032 checking the "Enable Script" checkbox.
0033 <p>
0034 These files will be created in the pykrita subfolder of your 
0035 resources directory. <p>
0036 <h3>Warning</h3>
0037 If a script with the name you choose already
0038 exists a warning will be shown in the status box. If you click 
0039 Create Script any files that already exist will be overwritten
0040 without further confirmation, so pay attention to any warnings. 
0041 
0042 </body>
0043 </html>
0044