[Starbound] Modding Guide: How to Make a Nippleswear Applier for Sexbound

[Locuturus]

First, what is nippleswear? Nippleswear is minor apparel concept added by Sexbound that enables player characters and NPCs to wear a fully transformable item part over its nipples. The nipples items are only visible while having sex, and they are special because they can be scaled to display smaller than a normal pixel.

 

You can find the both apparel appliers and removers for sale under the Infinity Express in the Outpost.

 

As you can see in the above example, the Floran actor is wearing a nipples item named Bone Skewers, but they are barely visible due to actor's body color. As you create your own wearable nipple items, be sure to keep in mind such a color contrast issue may arise for different species.

 

1) Create two new Apparel Applier Items.

 

This is the same concept as in Second Life, if you've ever used a skin applier. Only this method uses an active item which is consumed upon use.

1.1) Create the two required 'activeitem' files.

 

☑ In your mod, you should create your two new 'activeitem' files in the following folder location: /items/active/apparel_appliers

 

☑ Ensure that you create the active items in their own folder to stay organized.

e.g. customnipplering as /items/active/apparel_appliers/customnipplering

Note: You should replace 'customnipplering' with your own unique name so as to not conflict with other mods.

 

☑ In your new folder, create two 'activeitem' files with the same name as your custom folder's name, but one file name should end with a 1 and the other file name should end with a 2.

e.g. customnipplering1.activeitem & customnipplering2.activeitem

 

1.2) Create the active item used to apply the nipplewear item on the right nipple.

 

☑ Copy-Paste this JSON configuration into your 1st .activeitem as ending in 1 is correlated with the nipple on the right side. 

Note: notice that the applyConfig.target value is set as 1.

 

{
  "itemName"         : "customnipplering1",
  "category"         : "tradeGoods",
  "description"      : "Worn on your right nipple.",
  "inventoryIcon"    : "customnippleringicon.png",
  "itemTags"         : [ "sexbound" ],
  "level"            : 1,
  "maxStack"         : 99,
  "price"            : 50,
  "rarity"           : "Uncommon",
  "scripts"          : [ "/scripts/sexbound/applyapparel.lua" ],
  "scriptDelta"      : 60,
  "shortdescription" : "[SxB] Custom Nipple Ring (R)",
  "twoHanded"        : false,
  "applyConfig"      : {
    "target"   : 1,
    "itemName" : "customnipplering",
    "wornType" : "nipple"
  }
}

 

☑ Update the value of itemName to match your custom nipples wear mod name. Then update the applyConfig.itemName too.

Note: The applyConfig.itemName doesn't need to end with a 1 or 2. Unless you want to use different .nipples items for each nipple. (Advanced).

 

1.3) Create the active item used to apply the nipplewear item on the left nipple.

 

☑ Copy-Paste this JSON configuration into your 2nd .activeitem as ending in 2 is correlated with the nipple on the left side. 

Note: notice that the applyConfig.target value is set as 2.

 

{
  "itemName"         : "customnipplering2",
  "category"         : "tradeGoods",
  "description"      : "Worn on your left nipple.",
  "inventoryIcon"    : "customnippleringicon.png",
  "itemTags"         : [ "sexbound" ],
  "level"            : 1,
  "maxStack"         : 99,
  "price"            : 50,
  "rarity"           : "Uncommon",
  "scripts"          : [ "/scripts/sexbound/applyapparel.lua" ],
  "scriptDelta"      : 60,
  "shortdescription" : "[SxB] Custom Nipple Ring (L)",
  "twoHanded"        : false,
  "applyConfig"      : {
    "target"   : 2,
    "itemName" : "customnipplering",
    "wornType" : "nipple"
  }
}

 

☑ Update the value of itemName to match your custom nipples wear mod name. Then update the applyConfig.itemName too.

Note: The applyConfig.itemName doesn't need to end with a 1 or 2. Unless you want to use different .nipples items for each nipple. (Advanced).

 

1.4) Create the active item icon.

 

☑ In your "customnipplering" folder, add an icon that will be displayed for the active items.
e.g. customnippleringicon.png (16 x 16) sprite image (shown in inventory and when held in hand)

 

 

2) Create the New Nipples Item

 

2.1) Create the nipples item.

 

☑ You should create a new nipples item in the following location: /items/armor/sexbound/nipples

☑ Copy-Paste this JSON into a new file that ends in '.nipples'. Create this new file directly in the last folder location specified above.

e.g. customnipplering.nipples as /items/armor/sexbound/nipples/customnipplering.nipples

Note: both the file name and the itemName set in this file must to be same as the applyConfig.itemName values in the active item files created earler.

 

{
  "itemName" : "customnipplering",
  "category" : "nipples",

  "maleFrames" : {
    "image" : "customnipplering.png"
  },

  "femaleFrames" : {
    "image" : "customnipplering.png"
  },
  
  "sexboundConfig" : {
    "addStatus"    : [ "equipped_nipplering" ],
    "angularSpeed" : 0,
    "image"        : "/items/armors/sexbound/nipples/customnipplering.png",
    "startAngle"   : 0,
    "startScale"   : 0.5
  }
}

 

2.2) Create the nipples item image.

 

☑ Create a new 5x5 PNG image in the same folder location as your .nipples file.

Note: This is the actual image that will be applied over an actor's nipples.

Note: You can use an image larger than 5x5 but you have to define a custom .frames file for your image with the same name as the image. And kept in the same location as the image.

Note: This image is always centered over each nipple regardless of the image size.

Note: You can adjust the startScale to a value that you like, but don't go too small as it won't look good.

Note: addStatus can be used to add your own custom status names which can be used to choose dialogue by the SexTalk plugin.

Note: You can set an integer value for "angularSpeed" which will cause the worn nipples items to spin.
Note: You can set an integer value for "startAngle" to set the rotated angle of the worn item which is how you can make worn item at a 45 degree angle.

 

 

3) Distribute Your Custom Nippleswear Mod.

 

3.1) Pack your mod for distribution (Optional).
 
☑ In the 'win32' folder, you must use the asset_packer.exe file to pack the contents of your custom species support mod.
 
3.2) Archive the file and make it available for download.

Edited August 12, 2021 by Locuturus