Difference between revisions of "Skinning System"

From Starsonata Wiki
Jump to: navigation, search
 
Line 1: Line 1:
Everything in the "Content" directory tree is customizable by players, to make your own skin you should make a new folder in the "Content" directory which has any name you want. The client will automatically detect any skins you have, and will load them in an alphabetical order, taking any modifications that come first. Eg, if I have a skin named A and one Z, and both have modifications editing the galaxy map in, the galmap from A would be used. Default is automatically the lowest priority in loading skins.
+
Every file located in the <code>Star Sonata 2/Content</code> directory can be customized by players to create their own skins. Almost all aspects of the Star Sonata 2 client are customizable and located within this "Content" directory. This includes user interface (UI) layouts, graphics, models, textures, and more. To create your own skin, simply make a new folder inside the "Content" directory and give it a unique name.
  
You don't have to put every file in your skin directory tree. Only put the files that you change and their appropriate index files (game_data\images.xml, UI\XML\root.xml, etc). The client will automatically look for your files first, then if a file isn't in that tree, it will fetch it from the default tree.
+
The game client automatically detects all available skins at startup and loads them alphabetically. When multiple skins modify the same files, the skin earliest in alphabetical order takes precedence. For example, if two skins named "Alpha" and "Omega" both modify the galaxy map, the client will use the galaxy map from the "Alpha" skin. The "Default" skin provided by the game always has the lowest loading priority.
  
Don't edit any files in the default tree, as those will get overwritten when you patch. Instead, make your own skin directory and copy the file there and make your modification there. That way, when you patch, you won't lose any of your modifications.
+
When creating your custom skin, you don't need to copy every file from the Default game directory. Only include files you've modified along with their relevant index files (such as game_data\images.xml, UI\XML\root.xml, etc.). Your skin's directory structure should follow the structure of the Default directory. If it does not, your skin may fail to load properly.
  
Almost everything the Star Sonata 2 client uses is in the Content tree and is thus skinnable by players, include UI layout, graphics, models, textures, etc.
+
The client prioritizes loading files from your skin's directory first; if a file isn't found there, it uses the files located back in the Default directory. Never modify files directly within the Default directory, as game updates will overwrite your changes. Instead, copy files to your custom skin's directory and edit them there. This ensures your modifications are preserved across game updates.
  
Once you're done with your modifications, the client can read and unpack modifications from a compressed zip file, in this case the file is the directory in Content. The file path should look like something like this overall: Content/MyMod.zip/Textures/Ships/SuperCoolShipTexture.png
+
The game client can read any compressed .ZIP file. Once you've finished creating your skin, you can compress your skin for easy installation. The file path within the zip file should look similar to: <code>Content/MyMod.zip/Textures/Ships/SuperCoolShipTexture.png</code>.
  
Post anything you have made for other players to use, use the [https://discord.com/channels/162979076695523331/1350241316319268875 Modification] forum on Discord. Include a few screenshots and a download link to a compressed (.zip is suggested) file of your mod.
+
To share your skins with the community, please post them in the [https://discord.com/channels/162979076695523331/1350241316319268875 Modification] channel on the official Star Sonata Discord, along with a few screenshots and a direct download link or GitHub link to your skin file.
  
Any third party modifications are used at your own risk.
+
Note: The use of third-party modifications is at your own risk. If you have an issue with a skin, you should direct your feedback to the skin's developer.
  
 
[[Category:Client_Skinning]]
 
[[Category:Client_Skinning]]

Latest revision as of 21:28, 14 March 2025

Every file located in the Star Sonata 2/Content directory can be customized by players to create their own skins. Almost all aspects of the Star Sonata 2 client are customizable and located within this "Content" directory. This includes user interface (UI) layouts, graphics, models, textures, and more. To create your own skin, simply make a new folder inside the "Content" directory and give it a unique name.

The game client automatically detects all available skins at startup and loads them alphabetically. When multiple skins modify the same files, the skin earliest in alphabetical order takes precedence. For example, if two skins named "Alpha" and "Omega" both modify the galaxy map, the client will use the galaxy map from the "Alpha" skin. The "Default" skin provided by the game always has the lowest loading priority.

When creating your custom skin, you don't need to copy every file from the Default game directory. Only include files you've modified along with their relevant index files (such as game_data\images.xml, UI\XML\root.xml, etc.). Your skin's directory structure should follow the structure of the Default directory. If it does not, your skin may fail to load properly.

The client prioritizes loading files from your skin's directory first; if a file isn't found there, it uses the files located back in the Default directory. Never modify files directly within the Default directory, as game updates will overwrite your changes. Instead, copy files to your custom skin's directory and edit them there. This ensures your modifications are preserved across game updates.

The game client can read any compressed .ZIP file. Once you've finished creating your skin, you can compress your skin for easy installation. The file path within the zip file should look similar to: Content/MyMod.zip/Textures/Ships/SuperCoolShipTexture.png.

To share your skins with the community, please post them in the Modification channel on the official Star Sonata Discord, along with a few screenshots and a direct download link or GitHub link to your skin file.

Note: The use of third-party modifications is at your own risk. If you have an issue with a skin, you should direct your feedback to the skin's developer.