-
Notifications
You must be signed in to change notification settings - Fork 17
Creating a Shoes Content Pack
A content pack for Fashion Sense (FS) allows mod authors to create shoes with the following benefits:
- Can be larger than 16x32 pixels
- Can be animated
- Can override the player's shoes color
Fashion Sense content packs are compatible with other FS packs, meaning you can have as many Fashion Sense shoes as you'd like!
-
Create a parent folder with the content pack's name.
-
Create and fill in
manifest.json
as a content pack. -
Create a
Shoes
folder, add it under the content pack's main folder. -
Create a sub-folder under
Shoes
with the name of the shoesa. The name of the folder(s) under
Shoes
do not matter. -
Create a
shoes.json
under the created sub-folder, using the required fields found here. -
Create a
shoes.png
under the same sub-folder.a. The image size doesn't matter, so long as it is under 16384x16384 pixels (though smaller files are preferred to reduce memory usage).
A Fashion Sense content pack consists of the following structure:
[FS] Example Pack
├── manifest.json
│
└── Shoes
├── Sandals
│ ├── shoes.json
│ └── shoes.png
│
└── PunkBoots
├── shoes.json
└── shoes.png
If this is your first time creating a content pack, it may be useful to read the Stardew Valley Wiki for creating a content pack.
The first step to making your content pack is to create a top level folder with the name of your content pack. For example: [FS] Example Pack
.
After that, you'll want to create the manifest.json
file under that folder. Detailed instructions can be found on the Stardew Valley Wiki. Additionally, you can check out the example manifest.json as a reference.
For example:
[FS] Example Pack
└── manifest.json
It is important to note that the manifest.json
file must contain the following for it to be a content pack by Fashion Sense:
"ContentPackFor": {
"UniqueID": "PeacefulEnd.FashionSense",
"MinimumVersion": "USE.LATEST.VERSION"
}
Note: Replace "MinimumVersion": "USE.LATEST.VERSION"
with the latest version number of Fashion Sense found here.
You will first need to create a Shoes
folder underneath your main content pack folder.
After creating the Shoes
folder you'll want to create a sub-folder for every shoes you want to add, like so:
.
└── Shoes
├── Sandals
│
└── PunkBoots
You can also have sub-folders under the Shoes
folder for organizing, like so:
.
└── Shoes
├── Animated or Colorable
│ └── Sandals
│
└── Static
└── PunkBoots
To add a shoes to your content pack, the framework requires a shoes.json
under each sub-folder of Shoes
.
For example:
.
└── Shoes
├── Sandals
│ ├── shoes.json
│ └── shoes.png
│
└── PunkBoots
├── shoes.json
└── shoes.png
The file shoes.json
determines how the shoes is to be applied and allows the usage of certain conditions for animation.
An overview of the required properties for shoes.json
:
Property | Description | Default | |
---|---|---|---|
Name |
Required | Name of the shoes, which can contain spaces. | N/A |
Format |
Recommended | The format version to use, which should be set to Fashion Sense's current version. | "1.0.0" |
BackShoes |
Optional 1 | Specifies how the shoes will look while the player is facing backwards. See this page for more details. |
null |
RightShoes |
Optional 1 | Specifies how the shoes will look while the player is facing right. See this page for more details. |
null |
FrontShoes |
Optional 1 | Specifies how the shoes will look while the player is facing forward. See this page for more details. |
null |
LeftShoes |
Optional 1 | Specifies how the shoes will look while the player is facing left. See this page for more details. |
null |
-
At least one
ShoesModel
(FrontShoes, BackShoes, etc.) must be given for the shoes to be valid.a. Note that
ShoesModel
have their own required properties, as can be seen here.
This is a simple shoes.json
, which adds a static (non-animated) shoes that applies for all directions while the player is walking or running.
{
"Name": "Punk Boots",
"FrontShoes": {
"DisableGrayscale": true,
"StartingPosition": {
"X": 0,
"Y": 0
},
"BodyPosition": {
"X": 0,
"Y": -20
},
"ShoesSize": {
"Width": 16,
"Length": 16
},
"IdleAnimation": [
{
"Frame": 0,
"Duration": 100
}
],
"MovementAnimation": [
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsWalking",
"Value": true
}
]
},
{
"Frame": 1,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsWalking",
"Value": true
}
]
},
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsWalking",
"Value": true
}
]
},
{
"Frame": 3,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsWalking",
"Value": true
}
]
},
{
"Frame": 5,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsRunning",
"Value": true
}
]
},
{
"Frame": 5,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsRunning",
"Value": true
}
]
},
{
"Frame": 4,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsRunning",
"Value": true
}
]
},
{
"Frame": 4,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsRunning",
"Value": true
}
]
},
{
"Frame": 6,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsRunning",
"Value": true
}
]
},
{
"Frame": 6,
"EndWhenFarmerFrameUpdates": true,
"Conditions": [
{
"Name": "IsRunning",
"Value": true
}
]
}
]
}
}
The StartingPosition
property is used to determine where the starting point is (top-left most pixel for the ShoesModel
).
The BodyPosition
property is used to tell the framework where the player's body would be in relation to the shoes.
Note: It is important to know that each ShoesModel added (FrontShoes, BackShoes, etc.) must have a StartingPosition
, BodyPosition
and ShoesSize
, as the framework uses those properties to display the shoes.
The corresponding shoes.png
The layout requirements for shoes.png
is fairly relaxed, as the framework utilizes StartingPosition
, BodyPosition
and ShoesSize
to determine where the shoes sprites are located.
See the example pack for references on how to create your shoes.
This is an animated shoes.json
, which adds a shoes with an uniform animation and only applies while the player is facing forward.
{
"Name": "Sandals",
"FrontShoes": {
"DrawBeforePants": true,
"ColorMasks": [
[ 195, 195, 208 ],
[ 58, 58, 74 ]
],
"DisableSkinGrayscale": true,
"SkinToneMasks": {
"LightTone": [ 249, 174, 137 ],
"MediumTone": [ 224, 107, 101 ],
"DarkTone": [ 107, 0, 58 ]
},
"StartingPosition": {
"X": 0,
"Y": 0
},
"BodyPosition": {
"X": 0,
"Y": -20
},
"ShoesSize": {
"Width": 16,
"Length": 16
},
"IdleAnimation": [
{
"Frame": 0,
"Duration": 100
}
],
"MovementAnimation": [
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 1,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 3,
"EndWhenFarmerFrameUpdates": true
}
]
},
"BackShoes": {
"DrawBeforePants": true,
"ColorMasks": [
[ 195, 195, 208 ],
[ 58, 58, 74 ]
],
"DisableSkinGrayscale": true,
"SkinToneMasks": {
"LightTone": [ 249, 174, 137 ],
"MediumTone": [ 224, 107, 101 ],
"DarkTone": [ 107, 0, 58 ]
},
"StartingPosition": {
"X": 0,
"Y": 16
},
"BodyPosition": {
"X": 0,
"Y": -20
},
"ShoesSize": {
"Width": 16,
"Length": 16
},
"IdleAnimation": [
{
"Frame": 0,
"Duration": 100
}
],
"MovementAnimation": [
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 1,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 3,
"EndWhenFarmerFrameUpdates": true
}
]
},
"RightShoes": {
"DrawBeforePants": true,
"ColorMasks": [
[ 195, 195, 208 ],
[ 58, 58, 74 ]
],
"DisableSkinGrayscale": true,
"SkinToneMasks": {
"LightTone": [ 249, 174, 137 ],
"MediumTone": [ 224, 107, 101 ],
"DarkTone": [ 107, 0, 58 ]
},
"StartingPosition": {
"X": 0,
"Y": 32
},
"BodyPosition": {
"X": 0,
"Y": -20
},
"ShoesSize": {
"Width": 16,
"Length": 16
},
"IdleAnimation": [
{
"Frame": 0,
"Duration": 100
}
],
"MovementAnimation": [
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 1,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 3,
"EndWhenFarmerFrameUpdates": true
}
]
},
"LeftShoes": {
"Flipped": true,
"DrawBeforePants": true,
"ColorMasks": [
[ 195, 195, 208 ],
[ 58, 58, 74 ]
],
"DisableSkinGrayscale": true,
"SkinToneMasks": {
"LightTone": [ 249, 174, 137 ],
"MediumTone": [ 224, 107, 101 ],
"DarkTone": [ 107, 0, 58 ]
},
"StartingPosition": {
"X": 0,
"Y": 32
},
"BodyPosition": {
"X": 0,
"Y": -20
},
"ShoesSize": {
"Width": 16,
"Length": 16
},
"IdleAnimation": [
{
"Frame": 0,
"Duration": 100
}
],
"MovementAnimation": [
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 1,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 2,
"EndWhenFarmerFrameUpdates": true
},
{
"Frame": 3,
"EndWhenFarmerFrameUpdates": true
}
]
}
}
You can see UniformAnimation
was specified with 4 frames. UniformAnimation
always plays, so long as IdleAnimation
and MovementAnimation
aren't given.
To play an animation only while the player is moving, you would instead utilize MovementAnimation
. For more details see the animations page.
Conditions
can also be used to determine which frames are played. See the conditions page for more details.
The corresponding shoes.png
The layout requirements for animated shoes.png
is fairly relaxed, as it only requires the following condition(s):
- For ShoesModel with animation, each frame of the shoes should be placed next to each other horizontally (as seen in the example above).
See the example pack for references on how to create your shoes.
If you're looking for examples, see the examples page.