Hello there, and thank you for purchasing one or all of the parts of the Sizzlin' Spear from GlenSkunk Cocksmithing! This file will give you some important information about using these assets in your projects, as well as an update log to keep track of major updates to the files!

REQUIREMENTS:

To use these assets, you will require the following:

- Unity 2019.4.31f1 (Used by both VRC and CVR at the time of writing)

- The latest VRCSDK or ABI.CCK (depending on if you want to use these within VRC or CVR)

- Poiyomi Pro 8.2 or higher (only required if you wish to use the Thry's Penetration System prefabs included; for TPS prefabs specifically you cna downgrade to Poiyomi Pro 8.1 if a more recent version is unavailable)

- Dynamic Bones plugin (only required if you wish to use this dick inside of CVR; note that at time of writing Dynamic Bone-specific prefabs have not been created, so you may require an additional plugin to convert PhysBones into Dynamic Bones)

- Dynamic Penetration System 1.31 or higher (only requires if you wish to use the included DPS prefabs - also note that Poiyomi Pro 8.2 now includes an option to use DPS in it, akin to how it functioned in Poiyomi Pro 7.3)

- VRCFury 1.388+ (Only if you wish to use the dedicated VRCFury prefabs for easier installation; also required for the SPS versions of the prefabs; note this is *only* available for VRC)

For the included Blender and Substance Painter files, it is recommended you use the latest versions of Blender and Substance Painter (Substance Painter file was made in the 2020 Steam edition)


HOW TO USE:

First off, make sure you have Unity 2019.4.31f1 on your machine; this is what both VRChat and ChilloutVR use for their projects at the time of writing, so this will be what any avatar project you have is set up for.

Next up, open up the avatar project you desire to add the dick prefab to, whether through VRChat's Creator Companion, through Unity Hub or directly from the .unity scene file for the avatar. Make sure that you have also imported the plugins necessary for the specific prefab you want to use on your avatar (Dynamic Bones if you want to use the Dynamic Bones variants for CVR; Poiyomi Pro 8.1/8.2 if you want to use the TPS-enabled prefabs; VRCFury for both the VRCFury versions of the previous prefabs as well as the SPS prefabs)

Right-click in your avatar project's Assets folder and select "Import" and "Custom Package"; from the file browser screen that appears select the .unitypackage for your desired dick and select "Open." After a short time loading, a new window will show up that shows all the files of that .unitypackage you want to import; just click "Import" and the import process will begin.

Once the import completes, you should have a new folder that is named after the specific dick you imported in. In here are located all of the assets, prefabs and scenes for the specific dick: Animations, Materials, FBX, Prefabs and Scenes. Open the "Prefabs" folder and you should see every prefab variant for the dick, depending on whether it has been set up with Standard or Poiyomi Pro 8.2 materials, whether it has been set up for DPS, TPS or SPS, and if it uses VRCFury features aside from SPS.

Depending on your prefab of choice, follow either the VRCFury setup or the Manual Installation setup below! (Note that for CVR, only Manual Installation is available at present, and may require converting PhysBones to Dynamic Bones or replacing outright. SPS is also not available for CVR use due to being locked to VRCFury.)

(VRCFURY INSTALLATION)

If using a VRCFury prefab (especially the SPS prefabs), all you really need to do is drag the prefab as-is directly onto a bone in your avatar's armature (usually the Hips bone, but there's no specific bone required to allow the prefab to work - VRCFury will adjust the animations to work from whichever location you set it in). Depending on your needs, you can also have the prefab placed *outside* the avatar armature but on the same level as the armature and any body/clothing meshes your avatar has, then use a Parent Constraint pointed to an Empty placed underneath your intended target bone to lock the prefab to that Empty; for more details, check the extended Manual Installation write-up below!

All of the included FX controllers, menus and parameters will also be non-destructively merged into your avatar's Avatar Descriptor; if you wish to adjust some settings (like rewriting where the VRCFury component places the Eager Equine menu in your radial menu, or adjusting specifics of SPS to take different shapes into account) it is recommended to Unpack the prefab to modify the VRCFury component to your specific needs (recommended only for those already quite familiar with Unity and VRCFury).

Also be aware that the two prefabs using SPS - VRCFury's special Super Plug Shader - also require VRCFury to work; however, SPS does also offer a lot of quality of life features that may make this a great option for your needs! See the Tips section below for specifics!

(MANUAL INSTALLATION - FOR ADVANCED USERS)

If you're using one of the non-VRCFury prefabs (or are installing this onto a CVR project), go to your avatar's scene and drag your desired prefab into your scene's hierarchy (by default this will appear to the left side of your main editor window in Unity, but this may be different if you've modified your UI or are using a different UI preset); this will spawn the prefab at the origin point of your scene, either inside or outside your avatar's hierarchy. Then in the hierarchy, select the top-most layer of the dick prefab, right-click on it and select "Unpack Prefab;" this will turn the color of the assets within the prefab from blue to white, showing that it is no longer in its prefab state. Then go one level down from that top level (in this case, Hefty Horsin' Hose), then drag and drop that into your avatar's hierarchy (just under the avatar, NOT inside the armature or other parts below that hierarchy). The old top level is now no longer necessary and can be safely deleted.

(Why is this previous step necessary? It's simple - the premade animations for the dick were set up to work when the dick is just below the avatar's main section in the hierarchy so the animations don't need to be edited to account for a different hierarchy setup; the prefab's topmost level essentially acts the same as the avatar's topmost level, just without the Avatar Descriptors and other features. Since the avatar's top level is substituting for the prefab's top level here, the old prefab's top level is no longer needed once you get the dick into the avatar's hierarchy!)

Now that you have the dick inside the avatar's hierarchy, you can orient the dick to the desired position (around the groin/hips for most avatars, but your needs may vary), then add a Parent Constraint to the dick's top level if one is not already there; set it to point to the Hips bone of your avatar's armature, then select "Activate" and "Lock" inside the Parent Constraint. The dick should now follow along with your avatar's hips wherever the hips go!

Next up, you'll need to get the various premade toggles/animations into your avatar; included with the dick are four demonstration FX controllers (one each for DPS, TPS, SPS or non-deforming), each one including several premade animation toggles and parameters. You'll want to merge the toggles from the FX controller into your avatar's FX controller as well as adding the needed parameters for the toggles to work, both in your FX controller and in your Avatar Descriptor (a separate Expression Parameters file for VRChat, or within the Advanced Settings section of your avatar descriptor for ChilloutVR). You can either merge the animations into your avatar's FX controller using an outside plugin, or by manually copying and pasting the toggles from the demo FX controller into your avatar's FX controller. Be sure to add the created toggles to your avatar's Expressions Menus or Advanced Avatar Settings Menu to allow you to activate the toggles, depending on what program you're importing into!

You can now move on to more in-depth customization of your dick! A few tips to keep in mind:

-The recolorable prefabs are provided to allow in-Unity customization, albeit primarily for solid color changes; more complex customizations to the texture will require either modifying the raw texture files using an art program of your choice, or editing the provided Substance Painter file.

-Do note that due to the way that PhysBones interact with Constraints, using the Manual Installation method described above on a VRC avatar can lead to a local visual glitch where the dick physics may appear to follow the position of your head (either directly or in opposition to it). This is due to VRC running PhysBones calculations BEFORE constraint calculations and is currently unavoidable if you use the Manual Installation method; note that this is ONLY visible locally, others looking at your penetrator from the outside will not see this particular problem. If this particular motion is distracting or immersion-breaking for you, it is recommended to use the VRCFury installation method, as this removes the need for any kind of constraint on the penetrator. Technically you can also install the penetrator directly to the Hips bone manually without constraints, but this would require rewriting every animation for the penetrator to take the new position into account, or else using a dedicated plugin to retarget everything in each animation to this new position. (This particular visual glitch does not occur within CVR using the Manual Installation method due to differences in scripts and the way they're calculated.)

-If you opt to adjust the shape blendshapes to adjust the visual appearance of your TPS dick, it is recommended you rebake the penetrator to take these blendshape changes into account; otherwise when TPS is activated and the penetrator is brought to an orifice, the penetrator mesh will shift to reflect the default state of the penetrator when it was baked initially, which may result in unexpected deformations. It is also recommended to perform this if you want a static dick size that isn't included in the dick scale slider (less than 1/1/1 or greater than 3/3/3) to ensure deformations work as expected. You can edit the dick scale slider to take into account the new scales you want, although this is only recommended for advanced users who are familiar with how Unity animations work.

-If you are using the VRCFury SPS prefabs, you don't need to worry about the above scaling/blendshape tweaks - SPS automatically handles both baking the penetrator on Build no matter what blendshapes you set up, and adjusting the values for the scale of the dick on the dick scale animations! As an added bonus, it'll also auto-mask out the dick from the rest of the mesh based on bone weights, so if you want to change where the deformation begins on the dick you just need to move the SPS Config empty in the Hierarchy (placed by default underneath the Peen_Phys bone) to a different bone and zeroing-out the empty. SPS is also pre-built to work directly with VRCFury's OSC Goes Brrr technology, allowing penetration to active compatible toys via Intiface and OSC! (See OSC Goes Brrr documentation for more details on setup and use.)

-Want to use a different type of shader than Poiyomi Pro 8.1 or Unity Standard? It is recommended that if you wish to still have penetrator deformation, you use the VRCFury SPS prefabs for this purpose; SPS was written to be compatible with a much broader range of different shaders, including the free Poiyomi versions from 7.3 to 8.1, LilToon, XSToon, Mochie, Silent, and more! Do note that since SPS is built into VRCFury, SPS is not usable within CVR at present. (See SPS documentation for details about confirmed compatible shaders.)

-Want to add a particle effect of some kind to your dick? A dedicated "Cum Lock" empty placed at the tip of the dick is included so it's easier to have the particles emerge from the right spot, especially if you use a particle effect prefab with an automated installer (Ikeiwa Liquid System, PleasureArcade's Thicc Water, etc.).

-Are the dick state animations not working correctly on your avatar when you port them into your FX controller? (Like if the dick remains in the "Pouched" appearance no matter what dick state toggle you select for instance?) Check to see if your avatar's FX controller has masks on the layers; in recent iterations of the VRCSDK having masks on layers in your FX controller can cause animations to break. Note that this does NOT apply to the other controllers (Base, Gesture, Action etc.); only on the FX controller. You may also have a mismatch between Write Defaults on various animations in your FX controller that can cause the dick to act unpredictably; plugins like Avatar 3.0 Manager, Gesture Manager and VRCFury can help correct this issue.

Hopefully this helps you get your new dick up and running on your avatar; now go forth and start swingin' that meat!


UPDATE LOG:

v1 Beta: Initial testing and animations, including all prefabs
v2 Beta: Adjusted flaccid physics state to have added stiffness; fixed PhysBone placement in the DPS prefabs
v1.0 RC: Prepared package for sale!
v1.01: Fixed a minor texture bug where UV map seams were far more visible than intended, due to base color/albedo textures being purely passthrough without dilation
v1.02: Thanks to the latest v1.388 update to VRCFury, animated blendshapes can now be set to activate even when SPS is active, allowing SPS penetration to take changes to the dick mesh into account; with that in mind, all SPS prefabs have been updated to allow the included customization blendshapes to affect the dick even during SPS penetration, all via the included demo blendshape controls! Note that this will ONLY work if you have VRCFury version 1.388 or higher installed; all DPS, TPS and non-deforming blendshapes are unaffected by this change.