Modders Guide - Revision history

JYWLuca8269 at 17:05, 3 January 2022

2022-01-03T17:05:45Z

Bonewhip58: /* Example: Changing Game Parameters */

2018-10-22T15:46:51Z

Example: Changing Game Parameters

← Older revision		Revision as of 15:46, 22 October 2018
Line 115:		Line 115:
	For this example we are going to make three changes to the melee camera so that I can get a better look at the cool ships in SCO. Those changes are:		For this example we are going to make three changes to the melee camera so that I can get a better look at the cool ships in SCO. Those changes are:

	* ~~Change~~ maxSeparation from 40 to 12. This is how far apart the ships are allowed to be until the other ship goes off screen. At 40 the camera goes further back, but because of that the ships get very small. At 12 the ships stay large (but you will also have the other ship off screen a lot more).		* '''maxSeparation''' from 40 to 12. This is how far apart the ships are allowed to be until the other ship goes off screen. At 40 the camera goes further back, but because of that the ships get very small. At 12 the ships stay large (but you will also have the other ship off screen a lot more).
	* ~~Change~~ meleePaddingPercent from 1.3 to 1.6. This is the amount of padding the melee puts around the edge. In other words between as close as your ship can get to the edge of the screen. I like it a bit higher so I don't get surprised by things coming at me from the edge as frequently.		* '''meleePaddingPercent''' from 1.3 to 1.6. This is the amount of padding the melee puts around the edge. In other words between as close as your ship can get to the edge of the screen. I like it a bit higher so I don't get surprised by things coming at me from the edge as frequently.
	* ~~Change~~ isometricView from 0 to 1. This enables isometric view, so you see all the ships from a 3/4 view instead of top down.		* '''isometricView''' from 0 to 1. This enables isometric view, so you see all the ships from a 3/4 view instead of top down.

	Note that in the above we had to specify the internal name of the object we were modifying ("Default_MeleeParameters") and we got that name from the main games meleeparameters.xml file. After that, all the rules we learned in the preceding section apply. Make sure we have append="true" and only include the changes we want to make.		Note that in the above we had to specify the internal name of the object we were modifying ("Default_MeleeParameters") and we got that name from the main games meleeparameters.xml file. After that, all the rules we learned in the preceding section apply. Make sure we have append="true" and only include the changes we want to make.
Line 124:		Line 124:

	[[File:SCOIsometric.png]]		[[File:SCOIsometric.png]]


	== Adventure Studio ==		== Adventure Studio ==

Bonewhip58 at 15:11, 22 October 2018

2018-10-22T15:11:10Z

← Older revision		Revision as of 15:11, 22 October 2018
Line 8:		Line 8:

	This new mod directory mirrors the Assets directory used by the main game. And most of the games assets and definitions are exposed to xml and csv files in this structure to make it easy for modders to add and modify content. If you look through the main games asset directory you can get a feel for the wide variety of options that are exposed and moddable. This document will not go through all of them, it will show examples that will allow you to make your own changes.		This new mod directory mirrors the Assets directory used by the main game. And most of the games assets and definitions are exposed to xml and csv files in this structure to make it easy for modders to add and modify content. If you look through the main games asset directory you can get a feel for the wide variety of options that are exposed and moddable. This document will not go through all of them, it will show examples that will allow you to make your own changes.

			Making a mod requires a modder to get out into the file directories and get their hands dirty. Though there are parts that can be done from within the game (making new ships, buildings and uploading and updating your mod) and parts that can be done with Adventure Studio (creating dialog trees), it will also require manually updating files to bring it all together. We did that because with a tool you will only have the options the tool maker designs for you. When we give you access directly to the files you have the same control the designers who made the game have.

Bonewhip58 at 15:03, 22 October 2018

2018-10-22T15:03:43Z

← Older revision		Revision as of 15:03, 22 October 2018
Line 22:		Line 22:
	*'''author'''- This should be your name.		*'''author'''- This should be your name.
	*'''folderName'''- This is the name of the folder that you created in the Universes directory.		*'''folderName'''- This is the name of the folder that you created in the Universes directory.
			*'''modifies'''- This will typically always be "Origins" (to mod the base game). But if you are modding someone elses mod you would put their internalID here.
	*'''previewImage'''- This points to a .png file that is in the root directory for your mod. The resolution should be 512x512. You may want to have the art at the top of the image because the mod name will be overlayed over the bottom third of the image.		*'''previewImage'''- This points to a .png file that is in the root directory for your mod. The resolution should be 512x512. You may want to have the art at the top of the image because the mod name will be overlayed over the bottom third of the image.
	*'''modifies'''- This will typically always be "Origins" (to mod the base game). But if you are modding someone elses mod you would put their internalID here.
	*'''version'''- Use this to help track the version of the mod your players may be using.		*'''version'''- Use this to help track the version of the mod your players may be using.

Bonewhip58 at 15:03, 22 October 2018

2018-10-22T15:03:21Z

← Older revision		Revision as of 15:03, 22 October 2018
Line 22:		Line 22:
	*'''author'''- This should be your name.		*'''author'''- This should be your name.
	*'''folderName'''- This is the name of the folder that you created in the Universes directory.		*'''folderName'''- This is the name of the folder that you created in the Universes directory.
			*'''previewImage'''- This points to a .png file that is in the root directory for your mod. The resolution should be 512x512. You may want to have the art at the top of the image because the mod name will be overlayed over the bottom third of the image.
	*'''modifies'''- This will typically always be "Origins" (to mod the base game). But if you are modding someone elses mod you would put their internalID here.		*'''modifies'''- This will typically always be "Origins" (to mod the base game). But if you are modding someone elses mod you would put their internalID here.
	*'''version'''- Use this to help track the version of the mod your players may be using.		*'''version'''- Use this to help track the version of the mod your players may be using.

Bonewhip58 at 14:50, 22 October 2018

2018-10-22T14:50:36Z

← Older revision		Revision as of 14:50, 22 October 2018
Line 164:		Line 164:

	== Uploading a Mod ==		== Uploading a Mod ==
	~~Coming Soon~~		Uploading a mod to Steam Workshop is easy. Within the game the multiverse screen has an Upload button in the bottom right corner.

	[[File:SCOMultiverse.png]]		[[File:SCOMultiverse.png]]


			Once that is pressed you are taken to the Upload Mod screen. If you have filled out the name and description in the Manifest and included a preview image, those will all show up here automatically. Otherwsie you can fill out a name an description (I recommend putting this information in the manifest file otherwise you will need to type it in every time you update your mod).

			[[File:SCOUpload.png]]

			Lastly don't forget to select who can see your mod. Most of the time you probably want it set to "Everyone". But if you forget you can change the accessibility for the mod in steam workshop.

	[[Category:Star Control: Origins]] [[Category:Modding]]		[[Category:Star Control: Origins]] [[Category:Modding]]

Bonewhip58 at 18:25, 16 October 2018

2018-10-16T18:25:19Z

@@ Line 130: / Line 130: @@
 '''NOTE:''' Adventure Studio currently modifies the following base game files, Counters.xml, Flags.xml, GalaxyMarkers.xml, StarControlCharacters.xml and StarControlFleets.xml. This is dangerous because as you are modding the game you risk breaking the main game. A steam verify files will put you back to normal, but will also wipe out any mod work you have to those files. Stardock is working on an update to Adventure Studio which will correctly break out Mod content, but it isn't available at the time of this writing. In the meantime modders can use Adventure Studio to make mods, but then need to manually move mod content into their mod directories.
 === Example: Creating a Character ===
-Coming Soon
+[[File:SCOCharacter.png]]
 === Example: Creating a Quest ===

JYWLuca8269: Added category.

2018-10-16T16:01:17Z

Added category.

← Older revision		Revision as of 16:01, 16 October 2018
Line 144:		Line 144:

	[[File:SCOMultiverse.png]]		[[File:SCOMultiverse.png]]

			[[Category:Star Control: Origins]] [[Category:Modding]]

Bonewhip58 at 15:32, 16 October 2018

2018-10-16T15:32:16Z

← Older revision		Revision as of 15:32, 16 October 2018
Line 126:		Line 126:

	Adventure Studio is a tool Stardock used to create all the quests in the game. It has been made publicly available so that modders can use it as well.		Adventure Studio is a tool Stardock used to create all the quests in the game. It has been made publicly available so that modders can use it as well.

			Adventure Studio can be found where Star Control is installed. Look for ..\Star Control\AdventureStudio\AdventureStudio.exe.

	'''NOTE:''' Adventure Studio currently modifies the following base game files, Counters.xml, Flags.xml, GalaxyMarkers.xml, StarControlCharacters.xml and StarControlFleets.xml. This is dangerous because as you are modding the game you risk breaking the main game. A steam verify files will put you back to normal, but will also wipe out any mod work you have to those files. Stardock is working on an update to Adventure Studio which will correctly break out Mod content, but it isn't available at the time of this writing. In the meantime modders can use Adventure Studio to make mods, but then need to manually move mod content into their mod directories.		'''NOTE:''' Adventure Studio currently modifies the following base game files, Counters.xml, Flags.xml, GalaxyMarkers.xml, StarControlCharacters.xml and StarControlFleets.xml. This is dangerous because as you are modding the game you risk breaking the main game. A steam verify files will put you back to normal, but will also wipe out any mod work you have to those files. Stardock is working on an update to Adventure Studio which will correctly break out Mod content, but it isn't available at the time of this writing. In the meantime modders can use Adventure Studio to make mods, but then need to manually move mod content into their mod directories.

Bonewhip58 at 15:29, 16 October 2018

2018-10-16T15:29:37Z

← Older revision		Revision as of 15:29, 16 October 2018
Line 140:		Line 140:
	== Uploading a Mod ==		== Uploading a Mod ==
	Coming Soon		Coming Soon

			[[File:SCOMultiverse.png]]