Skip to content

README.md

Latest commit

 

History

History
73 lines (42 loc) · 4.93 KB

README.md

File metadata and controls

73 lines (42 loc) · 4.93 KB

Game Development Toolset

This is a series of tools geared towards assisting Houdini users with a variety of tasks for game development. The older version of this repository focused on just the shelf. Now this is an all-inclusive toolset that spans the shelf, digital assets, custom desktops and scripts.

If you'd like more information, please check out the wiki! (Also under construction)

NOTE: This is in-progress. Please file an Issue if something doesn't seem quite right! Guidelines can be found here.

Also, if you forked the respository and suddenly it stopped pulling, that's due to the link changing from https://github.com/sideeffects/GameDevelopmentShelf/ to https://github.com/sideeffects/GameDevelopmentToolset/. Github appears to forward traffic to the new link, but here's a little FYI just incase.

Installation

Instructions - Method 1 (User Preferences)

Download the repository using the green Clone or Download Button and unzip contents (otls, scripts, toolbar etc.) into the following folders depending on your operating system:

C:\Users\[username]\Documents\houdini[ver#]\          # Windows
/Users/[username]/Library/Preferences/houdini/[ver#]/ # OSX
/home/<USER>/houdini[ver#]/                           # Linux

Be sure to merge as needed! If you're copying and not cloning, the files shouldn't overwrite anything that doesn't involve the toolset.

Instructions - Method 2 (Custom Directory)

  1. Download or Clone the repository and unzip contents into a folder of your choice, e.g.:

     C:\Users\<USER>\Documents\houdini[ver#]\<CUSTOM_DIR>          # Windows 
 /Users/<USER>/Library/Preferences/houdini/[ver#]/<CUSTOM_DIR> # OSX
 /home/<USER>/houdini[ver#]/<CUSTOM_DIR>                       # Linux

  2. Open up your houdini.env file and add the path of your custom folder to HOUDINI_PATH environment variable, please note that even on a Windows machine forward slashes are required:

     HOUDINI_PATH = "C:/Users/<USER>/Documents/houdini[ver#]/<CUSTOM_DIR>;&"           # Windows
 HOUDINI_PATH = "/Users/<USER>/Library/Preferences/houdini/[ver#]/<CUSTOM_DIR>;&"  # OSX
 HOUDINI_PATH = "/home/<USER>/houdini[ver#]/<CUSTOM_DIR>;&"                        # Linux

    If HOUDINI_PATH already has an entry, you can concatenate the paths (separated by a semicolon):

     HOUDINI_PATH = "PATH/TO/DIRECTORY;PATH/TO/ANOTHER/DIRECTORY;&"

    In case houdini.env file doesn’t already exist, you can copy the provided houdini.env file of this repository into the following folders depending on your operating system:

     C:\Users\[username]\Documents\houdini[ver#]                  # Windows 
 /Users/[username]/Library/Preferences/houdini/[ver#]         # OSX
 /home/<USER>/houdini[ver#]                                   # Linux

What's Changed?

Hi, my name is Luiz Kruel and I have taken over the github from Steven B. who is now working in production. A few of the SideFX TAs (TDs) will also be contributing example files and tools.

We haven't done a lot in this Github in a while, but we are changing that. The original thought was that new tools would go straight into the build and the Github would eventually be phased out. But we saw a lot of value in having this experimental testbed for tools, so we will continue to develop our tools live and as they mature they will move into the main Houdini Build.

Live Development

We're actively working on building up the Houdini 16.0 branch of the toolset to match what's curently in the build. Currently we are moving tools over as bugs are indentified and fixed, and are placed here until they get added into the main Houdini build. We will also develop new tools moving forward using GitHub as our version control, so in the near future the 16.0 branch will become the default branch

Expanded HDAs

All of the HDAs are now using the new expanded format that was introduced in H16. This allows better diffing of the tools so you can see what our changes are doing and choose to integrate them back into your production.

Example Files

Instead of tying the examples as HDAs, we will be generating separate hip files that show how the tools should work in context

Branched Development

The Development branch is where we'll be working from. This is where the latest and greatest will live

Once an HDA is deemed ready, we will move it over to the Houdini XX branch where it will be more easily discovered by the population at large