[PYTHON] Let's introduce Bento Toolset.

What kind of person is Bento?

--Bento is Houdini Toolset from Open Source (MIT License) that I publish on GitHub. -The source code can be downloaded for each release, and if you download and connect the Houdini path, you can use the tool in Houdini immediately. It has become. --Because it is published on GitHub, you can freely fork it, send a pull request, manage it yourself, and participate in the development space shared by everyone.

What can you do?

Currently, the following tools are built into Bento.

Shelf Tools

Cache Dependency(cCDP)

--Create a File Cache SOP under the selected node, and create a Geometry ROP that reflects the parameters of the File Cache SOP on the ROP Network while setting the dependency. -Here also explains. --Click the image to jump to the video preview destination.

Create Delayed Load Procedural(cDLP)

--By selecting a cache file such as a BGEO file, a Delayed Load Procedural SHOP with the cache file input and a Geometry Network with the cache file input are created.

Python Panel

Cache Manager --Disk I / O nodes can be listed in a tree view. --The cache can be replaced on the panel. (Right click menu) --Nodes can be sorted by Read / Write. --For supported nodes, see here.

Script

Color Node Script

--A script that colors when you create a node. --Click here for a color scheme sample (https://github.com/takavfx/Bento/blob/develop/docs/color-nodes.md). -I wrote it in DFTALK, but the hip file becomes chaotic and it is difficult for others to read it. A script to reduce the cost.

Installation method

1. Download the latest source code from the "** releases **" page of Bento's repository page on GitHub.

2. Save the unzipped file to any location. -(Example) / Users / takanori / GitHub / Bento

3. Go to the Houdini user config location and open the houdini.env file. The save destination of houdini.env for each OS is the following path.

• (win) %HOME%/houdiniX.X/houdini.env
• (mac) $HOME/Library/Preferences/houdini/x.x/houdini.env
• (linux) $HOME/Houdinix.x/houdini.env

4. Add the path to the houdini.env file as shown below. 　　- (win) BentoPackagePath;& -(Mac / Linux) BentoPackagePath: & (; is also possible)

Like this ↓

houdini.env

#
# Houdini Environment Settings
#
# The contents of this file are read into the environment
# at startup.  They will override any existing entries in
# the environment.
#
# The syntax is one entry per line as follows:
#    VAR = VALUE
#
# Values may be quoted
#    VAR = "VALUE"
#
# Values may be empty
#    VAR =
#

# Example:
#
# HOUDINI_NO_SPLASH = 1

HOUDINI_PATH = /Users/takanori/GitHub/Bento:&

How can I participate in the development?

Necessary knowledge (generally)

language

• Python --A language that is very common in this industry. ――For beginners, I think it's a good idea to read this and enter it yourself to try it out. -> Learning site from introduction to application of Python
• Houdini Object Model(Hython) --A module (tool) for controlling Houdini using Python. --PySide (when making UI) --PyQt compatible UI module (tool) that can be used for commercial purposes. ――In the end, I think it would be nice if you could think that you are using this custom UI. --CSS (when making UI) --A language for designing UI, which is familiar on the Web.

version control

• Git --A classic version control system. It is no longer essential for multi-person development, not to mention individual development. --For Git, click here for beginners. -> Introduction to Git that even monkeys can understand ~ Let's master version control ~ | Project management backlog everywhere ――If you are a first-time user, you can visually grasp the branching and flow of the branch tree by using the GUI client, so it will be quick to remember. --Recommended is GitKraken. ――My personal taste. --Free use if it is for free. A subscription contract is required for paid use. --If you want to use the client for free even if you use it for a fee, we recommend Source Tree. -** "I think I was deceived and try it for the time being!" ! **
• Git Flow ――Determining rules for using Git. ――If you don't decide this, there is a possibility that the version will increase randomly and it will become chaos.
• GitHub Flow -Rules for using Git Hub. --By deciding this rule, release management on GitHub is performed. Manage things that are shared by everyone. -(As you can see from Bento's branch tree, I'm actually breaking the rules a bit ... I'll follow these rules in the future.)

Bento on GitHub

GitHub

• Bento Repository

branch

• develop
• Default branch.
• master
• Branch for release. The version to be displayed in "releases" is specified by tagging it here. This feature is useful for release management.
• feature/xxx
• Feature branch. A branch for intensive development of each feature you add.
• When developing Cache Manager, I created a branch called feature / cache-manager and developed it there.
• If you want to develop a script for changing node colors, you can create a branch such as feature / color-nodes and develop it freely there.
• hotfix/yyy
• Used to fix bugs in released ones.

directory

Bento basically conforms to Houdini's directory structure because I want you to use it just by connecting HOUDINI_PATH. Below is an example.

• Bneto/python2.7libs
• If you put a Python file here, Houdini will automatically import it at startup.
• Bento/scripts
• If you install a fixed script such as OnCreated.py here, it will be automatically executed at the specified operation.
• If OnCreated.py is installed, the Python script written when the node was created will be executed.
• If OnDeleted.py is installed, the Python script written when the node is deleted will be executed.
• Bento/python_panel
• When Houdini starts, it will automatically load the .pypanel files under this directory.
• Bento/toolbar
• When Houdini starts, it will automatically read the .shelf files under this directory.

Reference procedure

If you don't understand the terms, refer to the "Necessary knowledge (generally)" link above. It's easier and it's explained carefully.

The client uses GitKraken. A Git client like this.

[Purpose] I want to develop a color-nodes when creating a node.

1. Clone the repository from GitHub.

• For Bento, the repository URL is https://github.com/takavfx/Bento.git.
• File on the upper left Press the button to bring up the "Clone" menu. *

2. Switch to the master branch. *

3. Click the arrow button (Open Git Flow button) of Git Flow on the left menu. *

4. Click Start> Feature

5. Enter feature / parm-preset, select ** Current Branch ** with the radio button, and click Start feature. *

6. A new branch is created and switched to that new branch. *

7. Create an OnCreated.py file under Bento / scripts and write the script. save. *

8. Write the document in Bento / doc. Create a file such as ** color-nodes.md ** and write it in markdown.

9. Commit. (Frequently!)

• If you use the Atom editor as a sample, it will change the color of files and lines of added and changed ones, so it is easy to notice the timing of Commit. *
• If GitKraken is displayed horizontally, the changed file will be displayed in the information panel on the right side, and you can commit by staging and writing a Commit Message. *

10. Push to GitHub. (Frequently!) *

11. Repeat 7-8 until it has some shape.

12. Make a Pull Request to the develop branch on GitHub (if your code is complete). *

13. Pull Request is allowed. That is, the changes in color-nodes are applied to the develop branch.

14. Once tested with develop and ready to publish, send a Pull Request to merge the develop branch into the master branch.

15. Affected by the master branch if allowed.

16. Once tagged in the master branch and the release notes are written on GitHub, officially go to "** releases **" on GitHub. The version is registered and published.

Summary

There are still some things I'm making, and there are some improvement plans for the ones I've already made, but I hope everyone can participate and make a good Toolset.

• We look forward to your participation in the development! !! *