Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 5.3 KB

README.md

File metadata and controls

116 lines (87 loc) · 5.3 KB

Project Overview

This project can be used to programmatically convert the following into Fashion Sense packs:

  • a hairstyles.png, usually utilized in Content Patcher Packs
  • shirts from Json Assets
  • hats from Json Assets

Setup

Useful programs to have:

  • GIMP, a free open-source image editing software
  • Windows Terminal for running console commands, download found here

To run the code, you'll need node.js and npm, instructions found here

Setup Instructions

  1. Download node.js
  2. Pull down the code from github
  3. Open the project directory in the terminal (if you have Windows Terminal installed, all you have to do is be inside the directory and right click, then select Open Terminal here)
  4. Run npm install inside the project directory
  5. Create two empty folders inside the project directory, one called input and one called output
  6. Follow the instructions below, depending on what type of conversion you want to perform.

Convert Hairstyles to Fashion Sense mod packs!

Start here if you want to convert a hairstyles.png into a Fashion Sense modpack!

Step 1 - Copy the hairstyles!

Drag the hairstyles.png into the input directory in this project.

Step 2 - Run the code!

Run npm start -- -- --conversionType=hair --authorName=NAMEOFAUTHOR --hairDescriptor=ADJECTIVE.

There are a few customizable parameters that you can alter accordingly. First, you should enter the original name of the author whose hairstyles you are converting. This will enter it in Fashion Sense as AUTHOR's Hairstyle 01. If you specify a hairDescriptor, it will add that after the author's name, resulting in AUTHOR's ADJECTIVE Hairstyle 01, which makes it a lot easier to search for hairstyles you want in the Fashion Sense interface later.

For example, if you enter the command npm start -- -- --conversionType=hair --authorName=BikiFae --hairDescriptor=Braided, it will result in hairstyles named as BikiFae's Braided Hairstyle 01 (Dyeable).

Move these files from the output directory to your Fashion Sense pack, inside the "Hairs" directory.

You're done!

Extra Steps

You can also sort it by hairstyle descriptors, for example, dragging all of the long colorable hairstyles over at once, then running it with npm start -- -- --conversionType=hair --authorName=NAMEOFAUTHOR --hairDescriptor=Long which will result in hairstyles with names like AUTHORNAME's Long Hairstyle 01 (Dyeable).

Convert Shirts / Hats from Json Assets to Fashion Sense!

New functionality has been added to the project! Now you can convert Json Assets clothing and hat packs into Fashion Sense content packs.

Step 1 - Copy the files over

Inside the JSON assets package, copy the entire contents of the Hats OR Shirts directory inside the JA package over to the input directory. This application can only handle converting ONLY hats OR shirts at one time.

Step 2 - Run the Code!

Run the following command:

for a shirt:

npm start -- -- --conversionType=TYPE --authorName=AUTHOR --prefix=PREFIX --hasSleeves

for a hat:

npm start -- -- --conversionType=TYPE --authorName=AUTHOR --prefix=PREFIX
  • where TYPE is either hat or shirt
  • where AUTHOR is the name of the original author who created the shirts/hats
  • where PREFIX is a descriptor you want to go between the author name and the name of the item for all items in the set, for example, if it's a summer set, and you pass in --prefix=Summer then the items will be called something like AUTHOR's Summer Blouse. This is an OPTIONAL parameter and be removed if you do not want to use it.
  • if you don't want any of the shirts to have sleeves in the Fashion Sense framework, remove the --hasSleeves parameter from the command above. This only applies if you are using --conversionType=shirt.

Note: currently all sleeves default to white, since it's difficult to programmatically and accurately determine which color the sleeves should be. You can manually go in and change this later, file by file, if you so choose.

Step 3 - Copy the Files over to your Fashion Sense pack!

You will find the Fashion Sense shirts inside the output directory after running the command mentioned above. Go ahead and drag the contents of the output directory into a directory called Shirts in your Fashion Sense pack.

Step 4 (Optional) - Fix the Sleeve Colors

  1. Open the shirt.png file in your image editor of choice, one that specifically can read RGB values. I personally use GIMP for this, since it's free and open-source.
  2. Use the eye drop tool to select the color you want the sleeves to be, and find its RGB value.
  3. Open the shirt.json
  4. The property you'll be editing is SleeveColors and you'll have to edit it to be the same for both FrontShirt, BackShirt, LeftShirt, and RightShirt properties. As stated in the Fashion Sense documentation, "The first color given will replace the vanilla sleeve's darkest color, while the second replaces the medium color and the last will replace the lightest color."
  5. Take the RGB values and put them in that order for the SleeveColors property of all four options.
  6. Test it in game, and if you don't like the color, tweak it and preview it quickly via fs_reload.