DOCUMENTATION
0. OVERVIEW
2. INSTALLATION
4. CREATE OP
5. SEARCH OP
6. SEARCH CODE
7. LIBRARY
8. PALETTE
9. VST
10. RECENT PROJECTS
11. SETTINGS
12. UPDATE
13. WHY
14. CHANGELOG
0. OVERVIEW
Pisang is designed to significantly simplify and speed up boring actions and reduce amount of mouse clicks during daily life in TouchDesigner, like creating OPs and changing it's defualt settings, searching for OPs/old components or projects/palette comps/python code..
Pisang is injected directly into TouchDesigner user interface, thus it leaves no traces in your projects.
Pisang consists of several utilities centered around a "search bar" with customizable hotkeys and other settings.
ABBREVIATIONS:
TD - TouchDesigner
OP - TD's operator
UI - user interface
LMB - left mouse button
RMB - right mouse button
MMB - middle mouse button
[key] - keyboard button
1. SYSTEM REQUIREMENTS
Windows: Win 10+ modern gaming class machine.
Mac: M1 or higer, macOS 10.14+
TouchDesigner Free/Commercial/Pro, minimum build: 2023.12000
2. INSTALLATION
WINDOWS:
1. Drop pisang.tox to TD network editor -> Install
2. Confirm admin access (WHY?)
MACOS:
1. Allow TouchDesigner full disc access (WHY?):
OPTION+F2 -> Privacy & Security -> Full Disc Access -> TouchDesigner -> turn on (use + at bottom if there is no TouchDesigner in a list)
2. Drop pisang.tox to TD network editor -> Install
In case of success you will see pisang launcher icon next to 'Open palette' button.
NOTES:
All Pisang settings and data are stored on a disk, so it is possible to install and uninstall Pisang at any time without loosing any data.
Pisang data location could be changed via Pisang settings.
Pisang requires installation each time TD is updated, however all the settings will be loaded automatically.
UNINSTALL:
Go to Pisang setting -> uninstall.
3. TOOLSET AND USAGE
Pisang consists of several utilities centered around a "search bar".
Pisang tools are designed to enhance actual work by simplifying past works reusage and minimizing needs of file management.
Each tool could be assigned to keyboard shortcut via Settings.
GENERAL USAGE:
1. Click Pisang launcher icon - you are at the root level.
2. Select a tool
3. Use a tool.
Most of operations could be performed with keyboard only, by typing in Search Bar and up/down/enter keys.
LMB also works fine.
All tools could be assigned to keyboard hotkeys via Settings
Press ESC or click red dot to exit Pisang
Click ... at navigation bar to go back to root level or press [CMD/CTRL]+[UP]
Hold mouse pointer at navigation bar over current tool name to see quick help.
LIST OF TOOLS:
Create OP - Create new OPs and redefine defaults for new OPs
Search OP - Enchanced operator search
Search Code - Search python code through all DATs
Library - Save/Load components and templates
Palette - Search in TD palete
VST - VST plug-ins search and create vstCHOPs
Recent Projects - search through all recent projects
Settings - Pisang settings
4. CREATE OP
CREATE NEW OPs:
Create new OPs is similar to origianl TD 'create OP' dialog. [UP]/[DOWN]/[ENTER] keys also works.
USAGE:
1. Open the Create OP diaolg in a regular way.
2. Start typing the OP type. It is possible to search by word parts, for example:
'a de ou' -> audiodeviceoutCHOP
'a osc' -> audiooscillatorCHOP
3. Use [UP/DOWN] keys to select, [ENTER].
or
3. LMB on item.
REDEFINE DEFAULT SETTING FOR NEW OPs:
1. Select OP(s) in NetworkEditor with desired settings
2. Open Create OP tool
3. Type '='
4. Press [ENTER] -> Confirm
NOTES:
Will be saved/loaded as defaults: parameters and their modes and expressions, docked OPs and their parameters, DAT's content
5. SEARCH OP
Search OP by name or/and type.
The search performs within a current location and it's childs.
SEARCH SYNTAX:
'name type'
Both name and type are optional.
name and type are separated with space.
To search by OP type only - start with space, e.g. ' noisechop',' textdat',' sop'
Search results are sorted in following order:
1. Depth from current location
2. name search position in OP name
3. OP type
Pressing [UP]/[DOWN] keys or selecting with LMB - automatically navigates to selected OP
SEARCH EXAMPLES:
'no' - will find all types OPs with names like: noise1, mono1, nvdenoise1
'co cho' - will find CHOPs with names like 'constant', 'record'
' spee' - will find all speedCHOPs
6. SEARCH CODE
Search python code through all DATs
7. LIBRARY
Library Tool handles save/search/load OPs across different project.
It is possible to save/load both components and set of OPs, it's connections and parameter expressions (aka templates).
To search by multiple parts of the name - separete parts by spaces. For example searching for 'noiseWithSpeedOne' could be done by typing: 'no sp' or 'noise sp' or 'n sp on' e.t.c as well as with 'noisewiths'.
SAVE TO LIBRAY:
1. Select OP(s) in NetworkEditor
2. Open Library Tool
3. Type '+nameOfItem'
4. [ENTER]
LOAD FROM LIBRAY:
1. Start typing item name
2. Select item from the list with keyboard or mouse
3. [ENTER] or LMB
4. Place OP(s) in NetworkEditor
REMOVE FROM LIBRARY
1. Start typing '-nameOfItem'
2. LMB on item -> confirm
NOTES:
By default Library is located in TD preferences folder.
To change library location use Settings:
1. Settings -> library -> select new location
2. Check copy library to copy existed items to new location or uncheck to initialize empty library
MULTIPLE MACHINES:
In case using multiple machines - it is good idea to relocate the library to shared or cloud folder.
In our experience Dropbox works good for that, simply set 'Available Offline' for the folder via Dropbox settings.
In that case, the library will be accessible and synchronized across all computers, significantly simplifying components and templates reusage across all machines.
8. PALETTE
Search in TD palete
9. VST
VST plug-ins search and create vstCHOPs
10. RECENT PROJECTS
Search through all recent projects.
LMB or [ENTER] - load project
RMB - show project in folder
11. SETTINGS
general:
library - location for the most of data managed by Pisang. This location also used by Library and Recent Projects logs.
dialog size - the size of Pisang window.
num lines - number of visible lines with search results for all Pisang tools.
auto update - Pisang will check and install updates each time TD starts. Off by default.
scroll OP's parameters - Pisang will alter OP's parameter value under the mouse cursor. Handy while using touchpads. Off by default.
autosave - automaticaly save project every [autosave interval] minutes
autosave interval - if autosave is on, defines the interval in minutes
store OP defaults to library - if Yes, Create OP tool will store user defaults for new OPs in library folder, otherwise in local preferences folder.
uninstall - uninstall Pisang from TD. This will not affect Library data.
check updates - manualy check for Pisang updates.
hotkeys:
Assign hotkey for each tool:
1. Select a tool
2. [ENTER] or LMB
3. Press hotkey, or cancel/clear.
12. UPDATE
Go to Settings -> Check Updates, confirm if any.
Or
Perform Installation
CHECK UPDATES AUTOMATICALLY ON START TD:
Go to Settings -> Auto Update -> Yes
13. WHY
WHY GRANT ADMIN ACCESS DURING INSTALLATION AND UPDATE?
PisangCOMP is designed to be a part of TD ui, not a part of particular .toe file.
It is loaded dynamically in a same way most of TD ui elements are loaded.
After launching TD instance PisangCOMP is located here: /ui/dialogs/bookmark_bar which is part of /ui COMP.
/ui COMP is loaded from ui.tox on TD startup. Ui.tox is located in TD installation folder.
During installtion - Pisang copies itself to /ui/dialogs/bookmark_bar, adjust some parameters and saves /ui COMP back to TD installation folder.
Saving anything to TD installation folder requires admin access.
14. CHANGELOG
pisang 2.568
December 13, 2024
Library Tool: no name auto completions while adding template
pisang 2.567
December 10, 2024
Recent Projects: automatically finds projects located in shared folders saved from other machines.
pisang 2.566
December 07, 2024
library save bugfix
pisang 2.565
December 07, 2024
createOP sorting improvements
bugfixes
pisang 2.564
November 25, 2024
improvements: do not autoSave blank project
pisang 2.563
November 15, 2024
fixed: library does not working on first install
pisang 2.562
November 13, 2024
recent files on RMB fix
pisang 2.561
November 12, 2024
alt+scroll par -> affect parGroup
pisang 2.56
November 09, 2024
no privacy
pisang 2.559
June 23, 2024
UTF-8 with BOM
pisang 2.558
June 23, 2024
log files force encoding
pisang 2.557
June 19, 2024
quick switch to TD create OP
pisang 2.556
June 18, 2024
scroll parameters for multiple ops
pisang 2.555
June 18, 2024
handle binded parameters on scroll mouse
pisang 2.554
May 30, 2024
shift + click -> opens library instead of createOP
pisang 2.553
May 29, 2024
createOp search and sort improovments
pisang 2.552
May 28, 2024
scroll binded parameters
pisang 2.551
May 28, 2024
FIRST PUBLIC RELEASE