Author Topic: HOW TO create WSI2 files with Porting Kit  (Read 1624 times)

Offline vitormm

  • Developer
  • Administrator
  • Legendary Porter
  • *****
  • Posts: 943
HOW TO create WSI2 files with Porting Kit
« on: June 10, 2017, 05:17:05 PM »
Exporting WSI files was a feature available previously in Porting Center, however since we gonna keep everything inside Porting Kit from now on, and everything is being moved to it, the WSI creation is no exception. Firstly, you need a finished Wineskin, CXSkin, CXZ or CXEx. In case you don't have one, check the other guides first. Now, a little explanation about what is a WSI2 file:

A WSI2 file is a JSON-based file with port details inside. Basically, if you create a WSI2 file using Porting Kit for a wrapper, Porting Kit will be able to recreate that same wrapper using that same WSI2 file. That makes porting easier, since you will only need to share a 1.6Mb file instead of the real wrappers. You can even attach them in posts here in the forum, so there is no need to worry about hosting them too.

Well, now to the guide:

Step 0: Download the Porting Kit
You can find it here:

Step 1: Add the port to your PK library
Go the Library tab, then add the port to your Local tab. You can do that by dragging your port and dropping it in the library or by pressing the 'Add Application' button.

Step 2: Export your port as a WSI2
Right-click the port in the PK library and press "Export as WSI2...".

Step 3: Adjust the engine URL
That step is only valid if you are using a custom engine. You should provide a direct download link in the Engine URL field so PK can download it in order to create the port. If you are using a regular engine which is available in Wineskin Winery, just leave that field blank.

Step 4: Choosing the WSI source
That step is optional. In case your app can be acquired through a website, like Steam or GOG, you can provide the buying link in the Source URL field. You can also put the source name in the Source name field. The names that are in the Source name field combobox have icons in PK. Any other name will show the 'Other' source icon (an interrogation sign).

Step 5: Choosing the Dependency ID (Install tab)
Only valid if you are creating a WSI2 for an expansion pack or mod for a game which is already available in the Porting Kit. Put that game ID (which can be found be opening the game description in PK) in the Dependency ID (optional) field and you will be ready.

Step 6: Adding Extra Files
Extra files are files downloaded by PK during the installation process of the port, which might be downloaded to specific paths or simply executed by the port. That can be used to install the latest patch of a game, install a free game or even install mods. You just need to add a direct link to the file in the item Download Link column. You can also use the filename in that field in case there is no direct link for that file, so PK will ask for that file.

In the Destination Place column you may choose where in the wrapper it's going to be downloaded. In case it's only a one run time file, like a patch installer, press the Autorun ON/OFF button and the file will be downloaded to your Downloads folder. At least, you can choose between downloading the extra files before or after running the main installer of the app (if any). We gonna talk about that main installer again in step 8.

Step 7: Setting Genres
What they are used for? In offline WSIs, for nothing, but only for now. In future releases, PK will be able to search in Local and Server games by Genre, so it's good to keep that right. The tab itself is self explainable. Just check the Genres which your app apply for.

Step 8: Defining the Installer
In case your app requires an installer, like CD games or Microsoft Office, enable that option. With that, PK will ask for an installer while creating the port. In case you set the installer name, it will only allow the user to select an app which matches that name. At least, if your app is a Steam, Origin or Uplay game, you just need to check the option in that same tab. That will automatically download the program and install the required winetricks to run it. Talking about winetricks...

Step 9: Adjusting the winetricks
In case your app is an Origin game you won't need to install the Origin winetricks twice, since PK is already going to install them because you selected the Origin option in the previous tab. In case you accidentally installed two winetricks in sequence which nullifies the first one, you don't need to make other people install it too. In case a winetrick can only be installed after the app installer, there is no problem. Need to change the port engine? No problem. A winetrick is only needed by specific video cards? Your problems are over. These are some of the possible reasons to use that tab.

Everything related to winetricks and engine change can be solved in that tab. All the cases explained above can be solved by adjusting that tab correctly.

Step 10: Choose which registries to you want to preserve
Some games might require certain registry entries which need to be done manually in a Wineskin wrapper. For these case, you have the Registries tab. Write the registries that you want to be set in the wrapper and PK will do that for you.

Step 11: FnToggle
In case your app requires the F1-F12 regular functions and you don't want to hold Fn to use them, you just need to enable that option. It will automatically switch the Fn keys functions so you can use F1-F12 in your app, and as soon as you close it they will be back to their original state, and you will be able to increase and decrease your screen bright and change your volume.

Note: That feature ONLY works if you launch the app throw PK.

Step 12: Adjusting the Description and Trailer Link
(Still not available in PK). In the Description tab, you can right the app description and put a trailer link. You can put whatever you want in the description field, however, a warning: all the text font will be changed to Helvetica on saving, and PK will also set the font to Helvetica before showing it, so there is no way to use different fonts. The trailer link field supports links from YouTube, Vimeo, Yahoo Videos, DailyMotion, Vube and You can also use direct links of videos or images.

Step 13: Save the WSI2
Just press Finish and choose where do you want to save it. The created WSI2 should be able to create a perfect replica of your port, and all your friends will be able to use that same app by just installing a 1.6Mb file :)

The WSI2 files policy only have a few rules:
1. Don't use it to spread malwares (no exceptions);
2. Don't charge for it without PaulTheTall's and/or VitorMM's permission;
3. Don't create WSI files that install pirated copies of any kind.

And that's all. Enjoy it  ;D
« Last Edit: September 18, 2017, 01:15:59 PM by vitormm »