Guild of Writers

Latest revision as of 07:53, 4 March 2020

Welcome to this GoW Plugin tutorial on how to add footstep sound regions. This tutorial assumes you have followed the instructions on the installing PyPRP page. In this tutorial, you will learn how to add footstep regions. We will begin by adding the regions and then configure them.

Adding regions

1. Change one of the Blender windows to Scripts and use the Script button to add a PyPRP script. Then click "Add a Footstep Sound Region".
2. Select the second layer of the blender file, where the region is stored.
3. Set the region's object name. You will need these when adding the AlcScript later to properly configure them.
4. Change one of the windows to Text and choose AlcScript from the dropdown. The text window will now display the "# insert AlcScript code here" comment at the top of the window.
5. Insert the following AlcScript. Your code should look something like this example covering two regions.:

<objectname>:
   region:
      type: footstep
      surface: <surface name>

Alternative: Using Text Properties

1. Add the following text properties to the region.

<objectname>:
   type: region
   region:
      type: footstep
      surface: <surface name>

When you are done, you should have something like this. This concludes this GoW tutorial on adding footstep sound regions.

Available footstep sounds

Use one of these for the "surface" setting in the region properties/AlcScript.

• dirt
• puddle (Not implemented in PotS plasma. Do not use)
• water
• tile
• metal
• woodbridge
• ropeladder
• grass
• brush (Not implemented in PotS plasma. Do not use)
• hardwood
• rug
• stone
• mud (Not implemented in PotS plasma. Do not use)
• metalladder
• woodladder
• deepwater
• maintainerglass (Not implemented in PotS plasma. Do not use)
• maintainerstone (Not implemented in PotS plasma. Do not use)
• swimming

Notes

• When creating footstep regions you can put another footsteps region inside an existing one. For example, if the majority of your ground is stone, create a "stone" footstep region that encompasses the entire age. Then you can put grass footstep regions inside the stone region
• While a region can be any shame, the region bounds are "convex hull polytopes". This means that complex shapes will be "simplified". See Fig. 1 for an example
  

  Fig. 1. Convex Hull Example
• Try not to overlap footstep regions as they sometimes do not work properly when overlapping.
• In version 1.2.0, using the Scripts > Add > PyPRP > Add a Footstep Sound Region will set the text properties to the default.
• Text settings override AlcScript settings. If you intend to use AlcScript to set your surfaces, you will need to delete the surface property.