This is an old revision of the document!
Table of Contents
This page is not fully translated, yet. Please help completing the translation.
(remove this paragraph once the translation is finished)
User Guide
In this short guide, I will tell you how to prepare your system for launch Manager, and I'll also tell you how to use it. This guide is intended for users without programming skills.
Step 1. Install Python and PySide6
Since PUSSY is supplied as source code, an interpreter is needed to run it. To do this, go to the website python.org and download the distribution package for your operating system. Next, I will describe the installation process for Windows.
After downloading, run the executable file and mark the “Add Python 3.6 to the PATH” field, as shown in the figure (this may look different depending on the version you are installing).
Click “Install Now” to start the installation immediately or “Customize installation” to fine-tune the installation.
After installing Python, you need to install the PySide6 package. To do this, launch the Command Prompt application by pressing “Win+R” and type “cmd” and Enter, a terminal window should appear, then enter the command:
pip install PySide6
After downloading the package, the application is ready to launch.
The complex is written and tested in Python 3.11, so I recommend using this version or a newer one.
Step 2. Download the source code and run
To download, go to https://github.com/iron-mesh/utilities-box/репозиторийor look for additional upload methods on On the project page. On GitHub, click on the “Code” button and select “Download ZIP” or download the source archive in the Release section. After downloading, unpack the contents on your hard drive. Double-click the PUSSY.pyw file in the PUSSY/manager folder.
Step 3. Use
If all the previous steps were performed correctly, the main window of the Manager will appear on the screen. The main window will display the tabs of the Plug-ins that are currently installed and activated. By default, Plugins are initialized after the tab is activated, if you need to initialize it at startup, then you will be told how to do this.
To go to the list of installed plugins, press Ctrl+Alt+P. The first column shows the names of the Plug-ins; the second shows the activation buttons, with which you can turn plug-ins off or on at any time; the third shows the buttons to go to settings, if the button is not active, then there are no settings; the fourth shows additional options: Plugin Info - information about the plugin; Reset Settings - reset settings; Initialize on startup - initialize the plugin at startup.
The manager has a small list of settings, to access them you need to press Ctrl+Alt+S. // The first section contains settings for configuring the interface, it makes no sense to describe each of them, since their purpose should be clear. In the second section, there is one option: “External plugin directories” - this is a list of folders where the Manager searches for plugins, we will talk about them later. To apply the settings, click on //“Apply settings”. The //“Delete invalid data” button - // deletes data about plugins that have been deleted or are unavailable.
There is another section that most likely won't be of interest to regular users, but in some cases it can be useful, for example, if Plugins are not working correctly. We are talking about system messages, to go to them you need to press Ctrl+Alt +L, // information about the operation of plug-ins is displayed there, if the messages are highlighted in green, then everything is fine, if in red, then an exception occurred during operation. To display detailed information about exceptions, select the option //“Display error info in Logs” in the settings.
===== Step 4. Installing, removing plugins =====
//
Плагин - in fact, it is a package (based on Python terminology), it is a folder with files that contain the source code, it must contain a file named _ _init_ _.py.
In order to install the plugin, you just need to copy the source code folder to the PUSSY/manager/Plugins directory, or to any other folder specified in the settings under “External plugin directories”. //
Deletion is performed in the same way. After installing or deleting it, restart the Manager so that the changes take effect. To delete service information about deleted plugins, click on “Delete invalid data” in the settings section.
To learn how to develop your own plugins, see the relevant materials on this website.
