Modding Basics - Revision history

Vyvanseonline: /* Developer EXE */ Add link to dev.exe.

2019-10-01T01:46:40Z

Developer EXE: Add link to dev.exe.

← Older revision		Revision as of 01:46, 1 October 2019
Line 8:		Line 8:
	== Developer EXE ==		== Developer EXE ==

	All modders should start by taking advantage of the tools included when running the '''Sins of a Solar Empire Rebellion Dev.exe'''		All modders should start by taking advantage of the tools included when running the '''[[Developer_EXE\|Sins of a Solar Empire Rebellion Dev.exe]]'''

	Locate the game install directory and create a shortcut to the Dev.exe and move the shortcut to the desktop.		Locate the game install directory and create a shortcut to the Dev.exe and move the shortcut to the desktop.

Centaurianmudpig at 23:32, 2 October 2016

2016-10-02T23:32:21Z

← Older revision		Revision as of 23:32, 2 October 2016
Line 41:		Line 41:



	~~=== Example 1: Reference Data ===~~



	~~<br/>  ~~		=== Example 1: Remove Advent ===

	~~===   ===~~

	~~ ~~

	=== Example 2: Remove Advent ===

	'''''Summary:''' We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''		'''''Summary:''' We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''
Line 66:		Line 58:


	2. ~~Locate the '''Sins of a Solar Empire Rebellion''' Install directory, or''' '''[[Install_Directory\|<Sins Path>]]~~		2. Copy the '''entity.manifest''' from the [[Reference_Data\|<reference data>]] to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\01 - Remove Advent'''

	~~Example:[[Install_Directory\|<Sins Path>]]~~

	~~<code>C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion</code>~~

	Copy the '''entity.manifest''' from the [[~~Install_Directory~~\|<~~Sins Path~~>]]~~'''~~to~~'''~~ [[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\01 - Remove Advent'''


Line 79:		Line 65:

	''Note: Opening new mod file types for the first time will typically bring up the "Open with" window, choose a favorite text editor like Notepad or [[Modding_Tools\|NotePad++]].''		''Note: Opening new mod file types for the first time will typically bring up the "Open with" window, choose a favorite text editor like Notepad or [[Modding_Tools\|NotePad++]].''



	Search for PlayerPsiLoyalist.entity and remove the entire line.		Search for PlayerPsiLoyalist.entity and remove the entire line.
Line 112:		Line 100:


	=== Example 2: Weak Advent ===

			=== Example 2: Weak Advent Rebels ===

	'''''Summary:''' We are going to add the Advent Rebels back in, but they won’t have the technology to build all of their different capital ships.''		'''''Summary:''' We are going to add the Advent Rebels back in, but they won’t have the technology to build all of their different capital ships.''
Line 134:		Line 124:


	3. Copy [[~~Install_Directory~~\|<~~Sins Path~~>]]\GameInfo\PlayerPsiRebel.entity to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\02 - Weak Advent Rebels\GameInfo\PlayerPsiRebel.entity		3. Copy [[Reference_Data\|'''<reference data>''']]\GameInfo\'''PlayerPsiRebel.entity''' to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\02 - Weak Advent Rebels\GameInfo\'''PlayerPsiRebel.entity'''



	4. [[~~Convert_Data~~\|~~Convert~~]]~~ ~~PlayerPsiRebel.entity ~~to TXT format~~.		4. Open up [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\02 - Weak Advent Rebels\GameInfo\'''PlayerPsiRebel.entity''' in your favorite text editor.



	5. ~~Open up [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\02 - Weak Advent Rebels\GameInfo\PlayerPsiRebel~~.~~entity~~ in ~~your favorite text editor~~.		5. Search for “capitalShipInfo”. It should be on line 35 in the file.



	6~~. Search for “capitalShipInfo”. It should be on line 35 in the file.~~		6. Right below “capitalShipInfo”, change the “count 6” to “count 1”, then delete the next 5 lines:

	~~ ~~

	7. Right below “capitalShipInfo”, change the “count 6” to “count 1”, then delete the next 5 lines:


Line 182:		Line 168:


	3. Copy [[~~Install_Directory~~\|<~~Sins Path~~>]]\GameInfo\CAPITALSHIP_PSIBATTLEPSIONIC.entity to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels\GameInfo\CAPITALSHIP_PSIBATTLEPSIONIC.entity.		3. Copy [[Reference_Data\|'''<reference data>''']]\GameInfo\'''CAPITALSHIP_PSIBATTLEPSIONIC.entity''' to '''[[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\03 - Not So Weak Advent Rebels\GameInfo\'''CAPITALSHIP_PSIBATTLEPSIONIC.entity'''.

	~~ ~~

	~~4. [[Convert_Data\|Convert]] CAPITALSHIP_PSIBATTLEPSIONIC.entity to TXT format~~.



	5. Open CAPITALSHIP_PSIBATTLEPSIONIC.entity in a favorite text editor..		4. Open CAPITALSHIP_PSIBATTLEPSIONIC.entity in a favorite text editor..



	6. Search for “MaxHullPoints”. You should see “StartValue 2100.000000” right below it. Change this to “StartValue 1337000”.		5. Search for “MaxHullPoints”. You should see “StartValue 2100.000000” right below it. Change this to “StartValue 1337000”.

	Save and close this file.		Save and close this file.
Line 200:		Line 182:


	7. Copy your “'''String'''” directory from [[~~Install_Directory~~\|<~~Sins Path~~>]] to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels.		6. Copy your “'''String'''” directory from [[Reference_Data\|'''<reference data>''']] to '''[[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\03 - Not So Weak Advent Rebels.



	8. Open up [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels\String\English.str in your favorite text editor.		7. Open up '''[[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\03 - Not So Weak Advent Rebels\String\'''English.str''' in your favorite text editor.



	9. Search for “IDS_CAPITALSHIP_PSIBATTLEPSIONIC_NAME”. Right below this should be:		8. Search for “IDS_CAPITALSHIP_PSIBATTLEPSIONIC_NAME”. Right below this should be:

	Value “Rapture Battlecruiser”		Value “Rapture Battlecruiser”

Centaurianmudpig at 23:00, 2 October 2016

2016-10-02T23:00:44Z

← Older revision		Revision as of 23:00, 2 October 2016
Line 40:		Line 40:
	2. Create a new directory here. The name of the directory will be the name of the mod. You must restart the game to see any new mods. You won’t have to restart the engine to change a mod, just to create a new one and have it appear in the list.		2. Create a new directory here. The name of the directory will be the name of the mod. You must restart the game to see any new mods. You won’t have to restart the engine to change a mod, just to create a new one and have it appear in the list.

	3. The game is shipped with most of the data files converted to binary for optimization. The [[Convert_Data\|reference data]] files are text versions of any these files so that they’ll be easier to read and modify. The engine doesn’t care if the data files are in binary or text.

			=== Example 1: Reference Data ===



			<br/>

			===   ===



	=== Example 1: Remove Advent ===		=== Example 2: Remove Advent ===

	'''''Summary:''' We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''		'''''Summary:''' We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''
Line 58:		Line 66:


	2. Locate the '''Sins of a Solar Empire''' '''~~<Install directory>~~'''		2. Locate the '''Sins of a Solar Empire Rebellion''' Install directory, or''' '''[[Install_Directory\|<Sins Path>]]

	Example:		Example:[[Install_Directory\|<Sins Path>]]

	<code>C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion</code>		<code>C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion</code>

	Copy the '''entity.manifest''' from the '''~~<Install directory>~~ to''' [[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\01 - Remove Advent'''		Copy the '''entity.manifest''' from the [[Install_Directory\|<Sins Path>]]'''to''' [[Setting-up_Mods#Mod_Path\|<Mod Path>]]'''\01 - Remove Advent'''



	3. Open the new '''entity.manifest''' from the '''01 - Remove Advent '''mod. Opening new mod file types for the first time will typically bring up the "Open with" window, choose a favorite text editor like Notepad or [[Modding_Tools\|NotePad++]].		3. Open the new '''entity.manifest''' from the '''01 - Remove Advent '''mod.

			''Note: Opening new mod file types for the first time will typically bring up the "Open with" window, choose a favorite text editor like Notepad or [[Modding_Tools\|NotePad++]].''

	Search for PlayerPsiLoyalist.entity and remove the entire line.		Search for PlayerPsiLoyalist.entity and remove the entire line.
Line 94:		Line 104:


	4. Start the'''Sins of a Solar Empire Rebellion Dev.exe''' and enable your new mod. This may take a few seconds, the engine is restarting to use your new mod.		4. Start the '''Sins of a Solar Empire Rebellion Dev.exe''' and enable your new mod. This may take a few seconds, the engine is restarting to use your new mod.


Line 124:		Line 134:


	3. Copy ~~'''~~<~~Install directory~~>~~'''~~\GameInfo\PlayerPsiRebel.entity to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\02 - Weak Advent Rebels\GameInfo\PlayerPsiRebel.entity		3. Copy [[Install_Directory\|<Sins Path>]]\GameInfo\PlayerPsiRebel.entity to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\02 - Weak Advent Rebels\GameInfo\PlayerPsiRebel.entity


Line 153:		Line 163:

	8. Save the file, restart the game and enable this mod. Start the game as Advent Rebels and build the Capital Ship Factory. Note that you can now only build one type of capital ship!		8. Save the file, restart the game and enable this mod. Start the game as Advent Rebels and build the Capital Ship Factory. Note that you can now only build one type of capital ship!




Line 160:		Line 172:
	'''''Summary:''' We are going to buff up the only capital ship advent can build from Tutorial 02.''		'''''Summary:''' We are going to buff up the only capital ship advent can build from Tutorial 02.''

	1. Create a new directory in your <Mod Path> called ~~“03~~ - Not So Weak Advent ~~Rebels”~~

			1. Create a new directory in your [[Setting-up_Mods#Mod_Path\|<Mod Path>]] called “'''03 - Not So Weak Advent Rebels'''”



	2. Follow steps 2-5 in Tutorial 02. Or simply copy the GameInfo from Tutorial 02 into this tutorial’s directory.		2. Follow steps 2-5 in Tutorial 02. Or simply copy the GameInfo from Tutorial 02 into this tutorial’s directory.

	3. Copy <Sins Path>\GameInfo\CAPITALSHIP_PSIBATTLEPSIONIC.entity to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels\GameInfo\CAPITALSHIP_PSIBATTLEPSIONIC.entity.

			3. Copy [[Install_Directory\|<Sins Path>]]\GameInfo\CAPITALSHIP_PSIBATTLEPSIONIC.entity to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels\GameInfo\CAPITALSHIP_PSIBATTLEPSIONIC.entity.



	4. [[Convert_Data\|Convert]] CAPITALSHIP_PSIBATTLEPSIONIC.entity to TXT format.		4. [[Convert_Data\|Convert]] CAPITALSHIP_PSIBATTLEPSIONIC.entity to TXT format.



	5. Open CAPITALSHIP_PSIBATTLEPSIONIC.entity in a favorite text editor..		5. Open CAPITALSHIP_PSIBATTLEPSIONIC.entity in a favorite text editor..



	6. Search for “MaxHullPoints”. You should see “StartValue 2100.000000” right below it. Change this to “StartValue 1337000”.		6. Search for “MaxHullPoints”. You should see “StartValue 2100.000000” right below it. Change this to “StartValue 1337000”.
Line 174:		Line 198:
	Save and close this file.		Save and close this file.

	7. Copy your ~~“String”~~ directory from <[[Install_Directory]]> to [[Setting-up_Mods#Mod_Path\|<Mod Path>]].

			7. Copy your “'''String'''” directory from [[Install_Directory\|<Sins Path>]] to [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels.



	8. Open up <Mod Path>\String\English.str in your favorite text editor.		8. Open up [[Setting-up_Mods#Mod_Path\|<Mod Path>]]\03 - Not So Weak Advent Rebels\String\English.str in your favorite text editor.



	9. Search for “IDS_CAPITALSHIP_PSIBATTLEPSIONIC_NAME”. Right below this should be:		9. Search for “IDS_CAPITALSHIP_PSIBATTLEPSIONIC_NAME”. Right below this should be:
Line 187:		Line 217:



			[[Category:Modding]]

Centaurianmudpig at 19:32, 1 October 2016

2016-10-01T19:32:29Z

@@ Line 142: / Line 142: @@
 . Right below “capitalShipInfo”, change the “count 6” to “count 1”, then delete the next 5 lines: &nbsp;
 &nbsp;
 &nbsp;
@@ Line 152: / Line 150: @@
 &nbsp;
 &nbsp;
- &nbsp;
-<nowiki> capitalShipInfo Page:0 count 1 entityDefName "CAPITALSHIP_PSIBATTLESHIP2" </nowiki>
+. Save the file, restart the game and enable this mod. Start the game as Advent Rebels and build the Capital Ship Factory. Note that you can now only build one type of capital ship!
 &nbsp;
-. Save the file, restart the game and enable this mod. Start the game as Advent Rebels and build the Capital Ship Factory. Note that you can now only build one type of capital ship!
+=== Example 3: Not So Weak Advent ===

Centaurianmudpig at 18:45, 1 October 2016

2016-10-01T18:45:27Z

← Older revision		Revision as of 18:45, 1 October 2016
Line 136:		Line 136:


	6. Search for “capitalShipInfo”. It should be on line 29 in the file.		6. Search for “capitalShipInfo”. It should be on line 35 in the file.



	7. Right below “capitalShipInfo”, change the “count 5” to “count 1”, then delete the next 4 lines:		7. Right below “capitalShipInfo”, change the “count 6” to “count 1”, then delete the next 5 lines:

	~~entityDefName “CAPITALSHIP_PSIBATTLESHIP”~~

	entityDefName ~~“CAPITALSHIP_PSIPLANETPSIONIC”~~		<nowiki> entityDefName "CAPITALSHIP_PSIBATTLESHIP" entityDefName "CAPITALSHIP_PSIPLANETPSIONIC" entityDefName "CAPITALSHIP_PSICOLONY" entityDefName "CAPITALSHIP_PSICARRIER" entityDefName "CAPITALSHIP_PSIBATTLEPSIONIC" </nowiki>

	entityDefName ~~“CAPITALSHIP_PSICOLONY”~~

	entityDefName ~~“CAPITALSHIP_PSICARRIER”~~


Line 154:		Line 150:
	You should now see:		You should now see:

	~~capitalShipInfo~~

	~~Page:0 count 1~~

	entityDefName ~~“CAPITALSHIP_PSIBATTLEPSIONIC”~~

			<nowiki> capitalShipInfo Page:0 count 1 entityDefName "CAPITALSHIP_PSIBATTLESHIP2" </nowiki>



	8. Save the file, restart the game and enable this mod. Start the game as Advent Rebels and build the Capital Ship Factory. Note that you can now only build one type of capital ship!		8. Save the file, restart the game and enable this mod. Start the game as Advent Rebels and build the Capital Ship Factory. Note that you can now only build one type of capital ship!

Centaurianmudpig at 18:02, 1 October 2016

2016-10-01T18:02:54Z

@@ Line 46: / Line 46: @@
 === Example 1: Remove Advent ===
-''Summary: We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''
+'''''Summary:''' We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''
 &nbsp;
@@ Line 104: / Line 104: @@
 === Example 2: Weak Advent ===
-'''''Summary:''' We are going to add the advent back in, but they won’t have the technology to build all of their different capital ships.''
+'''''Summary:''' We are going to add the Advent Rebels&nbsp;back in, but they won’t have the technology to build all of their different capital ships.''
-. Create a new directory in your [[Setting-up_Mods#Mod_Path|<Mod Path>]] called “'''02 - Weak Advent'''”
+&nbsp;

Centaurianmudpig: Created page with " == How Mods Work == The engine will attempt to find the files it needs in mods before searching the root game path. Mods work by simply providing the different files to use...."

2016-10-01T16:50:59Z

Created page with " == How Mods Work == The engine will attempt to find the files it needs in mods before searching the root game path. Mods work by simply providing the different files to use...."

New page

== How Mods Work ==

The engine will attempt to find the files it needs in mods before searching the root game path. Mods work by simply providing the different files to use.

 

== Developer EXE ==

All modders should start by taking advantage of the tools included when running the '''Sins of a Solar Empire Rebellion Dev.exe'''

Locate the game install directory and create a shortcut to the Dev.exe and move the shortcut to the desktop.

Example:

<code>C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion\Sins of a Solar Empire Rebellion Dev.exe</code>

 

Running the '''Sins of a Solar Empire Rebellion Dev.exe '''and clicking show mod path will create the developer mod folder for the current installed version.

[[File:Mod Path.png|left|Mod Path.png]]

 

 

 

Example:

<code>C:\Documents\My Games\Ironclad Games\Sins of a Solar Empire Rebellion\Mods-Rebellion v1.85 Dev</code>

 

== Start a New Mod ==

1. Find the [[Setting-up_Mods#Mod_Path|<Mod Path>]] that the game will use.

2. Create a new directory here. The name of the directory will be the name of the mod. You must restart the game to see any new mods. You won’t have to restart the engine to change a mod, just to create a new one and have it appear in the list.

3. The game is shipped with most of the data files converted to binary for optimization. The [[Convert_Data|reference data]] files are text versions of any these files so that they’ll be easier to read and modify. The engine doesn’t care if the data files are in binary or text.

 

=== Example 1: Remove Advent ===

''Summary: We are going to remove an entire race from the game. No one will be able to play the Advent in our new Mod.''

 

1. Create a new directory in your [[Setting-up_Mods#Mod_Path|<Mod Path>]] called “'''01 - Remove Advent'''”.

Example:

<code>C:\Documents\My Games\Ironclad Games\Sins of a Solar Empire Rebellion\Mods-Rebellion v1.85 Dev\01 - Remove Advent</code>

 

2. Locate the '''Sins of a Solar Empire''' '''<Install directory>'''

Example:

<code>C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion</code>

Copy the '''entity.manifest''' from the '''<Install directory> to''' [[Setting-up_Mods#Mod_Path|<Mod Path>]]'''\01 - Remove Advent'''

 

3. Open the new '''entity.manifest''' from the '''01 - Remove Advent '''mod. Opening new mod file types for the first time will typically bring up the "Open with" window, choose a favorite text editor like Notepad or [[Modding_Tools|NotePad++]].

Search for PlayerPsiLoyalist.entity and remove the entire line.

[[File:Remove Advent 2.png|RTENOTITLE]]

Search for PlayerPsiRebel.entity and remove the entire line.

[[File:Remove Advent 1.png|RTENOTITLE]]

After both lines are removed, the section should look like this.

[[File:Remove Advent 3.png|RTENOTITLE]]

Scroll to the top and change the count -2.

was <code>entityNameCount 1764</code>

now <code>entityNameCount 1762</code>

[[File:Remove Advent 4.png|RTENOTITLE]]

Save the file.

 

4. Start the'''Sins of a Solar Empire Rebellion Dev.exe''' and enable your new mod. This may take a few seconds, the engine is restarting to use your new mod.

 

5. Now setup a new game. Note that you can no longer select the Advent race for you player. It has been removed.

 

=== Example 2: Weak Advent ===

'''''Summary:''' We are going to add the advent back in, but they won’t have the technology to build all of their different capital ships.''

1. Create a new directory in your [[Setting-up_Mods#Mod_Path|<Mod Path>]] called “'''02 - Weak Advent'''”