Reference Data: Difference between revisions

From Sins of a Solar Empire - Official Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:


The game is shipped with most of the data files converted to binary for optimization. The <reference data> files are text versions of any these files so that they’ll be easier to read and modify. Other than a 2GB RAM limit, and game load time, the engine doesn’t care if the data files are in binary or text format.
The game is shipped with most of the data files converted to binary for optimization. The <reference data> files are text versions of any these files so that they’ll be easier to read and modify. Other than a 2GB RAM limit, and game load time, the engine doesn’t care if the data files are in binary or text format.
&nbsp;


&nbsp;
&nbsp;
Line 34: Line 36:
<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 the following folders&nbsp;from the&nbsp;'''[[Install_Directory|<Sins Path>]]'''&nbsp;to ''''''<reference data>''''''
Copy the the following folders&nbsp;from the&nbsp;'''[[Install_Directory|<Sins Path>]]'''&nbsp;to '''''<reference data>'''''


*GameInfo  
*GameInfo  
Line 47: Line 49:
&nbsp;
&nbsp;


3. Copy '''[[Install_Directory|<Sins Path>]]\ConvertData_Rebellion.exe'''to ''''''<reference data>'''\ConvertData_Rebellion.exe'''
3. Copy '''''[[Install_Directory|<Sins Path>]]''\ConvertData_Rebellion.exe'''&nbsp;''to'''''<i>&nbsp;</i>''''''''<b><reference data></b>''\ConvertData_Rebellion.exe


&nbsp;
&nbsp;
Line 61: Line 63:
&nbsp;
&nbsp;


1. Inside ''''''<reference data>'''''', create a new text document and name it "'''Convert Entity to Text'''". If the '''.txt''' extention is visible, change this to '''.bat'''. It can also be done with "Save as".
1. Inside '''''<b><reference data></b>''''', create a new text document and name it "'''Convert Entity to Text'''". If the '''.txt''' extention is visible, change this to '''.bat'''. It can also be done with "Save as".


&nbsp;
&nbsp;
Line 97: Line 99:
&nbsp;
&nbsp;


4. Repeat steps 1 and 2 following the table below to create all the necessary&nbsp;.bat files
4. Repeat steps 1 and 2 following the table below to create all the necessary&nbsp;.bat files, or [https://1drv.ms/f/s!AsOENqwKvLRLgcl5GaeSRxNz5bz9tA Download]&nbsp;them.


''Note: The 1st in the list should already be created in steps 1 and 2.''
''Note: The 1st in the list should already be created in steps 1 and 2.''[[File:Download.png|right|Select All > Download > Extract files to mod folder|link=https://1drv.ms/f/s!AsOENqwKvLRLgcl5GaeSRxNz5bz9tA]]


{| border="0" cellpadding="1" cellspacing="1"
{| border="0" cellpadding="1" cellspacing="1"
Line 113: Line 115:
|-
|-
| '''Convert Mesh to Text'''
| '''Convert Mesh to Text'''
| <code>for&nbsp;%%a in (Mesh\*.mesh) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a txt</code>
| <code>for&nbsp;%%a in (Mesh\*.mesh) do ConvertData_Rebellion mesh&nbsp;%%a&nbsp;%%a txt</code>
|-
|-
| '''Convert Mesh to Bin'''
| '''Convert Mesh to Bin'''
| <code>for&nbsp;%%a in (Mesh\*.mesh) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a bin</code>
| <code>for&nbsp;%%a in (Mesh\*.mesh) do ConvertData_Rebellion mesh&nbsp;%%a&nbsp;%%a bin</code>
|-
|-
| '''Convert Particle to Text'''
| '''Convert Particle to Text'''
| <code>for&nbsp;%%a in (Particle\*.particle) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a txt</code>
| <code>for&nbsp;%%a in (Particle\*.particle) do ConvertData_Rebellion particle&nbsp;%%a&nbsp;%%a txt</code>
|-
|-
| '''Convert Particle to Bin'''
| '''Convert Particle to Bin'''
| <code>for&nbsp;%%a in (Particle\*.particle) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a bin</code>
| <code>for&nbsp;%%a in (Particle\*.particle) do ConvertData_Rebellion particle&nbsp;%%a&nbsp;%%a bin</code>
|-
|-
| '''Convert Brushes to Text &nbsp;&nbsp;'''
| '''Convert Brushes to Text &nbsp;&nbsp;'''
| <code>for&nbsp;%%a in (Window\*.brushes) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a txt</code>
| <code>for&nbsp;%%a in (Window\*.brushes) do ConvertData_Rebellion brushes&nbsp;%%a&nbsp;%%a txt</code>
|-
|-
| '''Convert Brushes to Bin'''
| '''Convert Brushes to Bin'''
| <code>for&nbsp;%%a in (Window\*.brushes) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a bin</code>
| <code>for&nbsp;%%a in (Window\*.brushes) do ConvertData_Rebellion brushes&nbsp;%%a&nbsp;%%a</code>
|}
|}


Line 138: Line 140:
*Double-Left-click or select "'''Convert Brushes to Text.bat'''"'''&nbsp;'''and press '''[''Enter'']'''&nbsp;to activate the .bat file. Wait for it to loop through and convert all the brushes files to text format.  
*Double-Left-click or select "'''Convert Brushes to Text.bat'''"'''&nbsp;'''and press '''[''Enter'']'''&nbsp;to activate the .bat file. Wait for it to loop through and convert all the brushes files to text format.  
*"'''Convert Mesh to Text.bat'''" is optional. The next step will show how to covert a single mesh file.  
*"'''Convert Mesh to Text.bat'''" is optional. The next step will show how to covert a single mesh file.  
&nbsp;


&nbsp;
&nbsp;
Line 149: Line 153:
=== Command Prompt ===
=== Command Prompt ===


The XSI modeling tutorials use the Advent Light Frigate aka <code>Frigate_PsiLight.mesh</code>, this is the mesh file this tutorial will use.
The XSI modeling tutorials use the [[Disciple_Vessel|Advent Light Frigate]] aka <code>Frigate_PsiLight.mesh</code>, this is the mesh file this tutorial will use.


&nbsp;
&nbsp;
Line 211: Line 215:


== Modding Tools ==
== Modding Tools ==
Incude the tool directories with the '''[[#Reference_Data_mod_Folder|<reference data>]]'''. Working from a mod folder has benifits and leaves the '''''[[Install_Directory|<Sins Path>]]''''' intact.


[[File:Sins Modding Tools.png|right|Sins Modding Tools.png]]
[[File:Sins Modding Tools.png|right|Sins Modding Tools.png]]


*ConvertXSI  
*[[Convert_XSI|ConvertXSI]]
*Galaxy Forge  
*[[Galaxy_Forge|Galaxy Forge]]
*Particle Forge  
*[[Particle_Forge|Particle Forge]]
 
[[File:Reference Data Dir3.png|RTENOTITLE]]
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
== Check Game Integrity ==
 
[[File:Steam Properties Local.png|right|Steam Properties Local.png]]Once all the files that are needed for modding are copied from [[Install_Directory|<Sins Path>]], it may be a good idea to check that all the files are in a good state.
 
&nbsp;
 
Navigate to the Steam Library&nbsp;
 
Locate Sins of a Solar Empire Rebellion
 
'''right-click --> Properties'''
 
Select the "'''LOCAL FILES'''" tab.
 
Click on "'''VERIFY INTEGRITY OF GAME CACHE...'''"


&nbsp;
&nbsp;


&nbsp;
&nbsp;
&nbsp;
&nbsp;
== Archive and Upload ==
Archive the entire <reference data> directory and name the archive using the current version. This tutorials version is 1.85
Rebellion_1.85_Reference_Data.zip
&nbsp;
&nbsp;
modDB is a popular upload site. Join the [http://www.moddb.com/company/soase-m0dders Sins Modders group] and you can upload an archive directly to the groups files section.
[http://www.moddb.com/company/soase-m0dders/downloads http://www.moddb.com/company/soase-m0dders/downloads]


&nbsp;
&nbsp;


[[Category:Modding]]
[[Category:Modding]]

Latest revision as of 17:45, 3 October 2016

Summary: We are going to create a mod folder with all the converted files and tools to <reference data> from.

 

The game is shipped with most of the data files converted to binary for optimization. The <reference data> files are text versions of any these files so that they’ll be easier to read and modify. Other than a 2GB RAM limit, and game load time, the engine doesn’t care if the data files are in binary or text format.

 

 

Reference Data mod Folder

1. Create a new directory in your <Mod Path> called “Reference Data”.

 

Example: <reference data>

C:\Documents\My Games\Ironclad Games\Sins of a Solar Empire Rebellion\Mods-Rebellion v1.85 Dev\Reference Data

 

The term <reference data> will refer to an equivalent active mod folder location like the example path above.

 

Convert Folders.png
Convert Folders.png

 

2. Locate the Sins of a Solar Empire Rebellion Install directory, or <Sins Path>

Example:<Sins Path>

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

Copy the the following folders from the <Sins Path> to <reference data>

  • GameInfo
  • Mesh
  • Particle
  • Window

Note: Not all the files contained in these folders need to be converted to text, but the files are modifiable.

 

 

3. Copy <Sins Path>\ConvertData_Rebellion.exe to '''<reference data>\ConvertData_Rebellion.exe

 

 

Batch Convert

Create txt.png
Create txt.png

 

 

1. Inside <reference data>, create a new text document and name it "Convert Entity to Text". If the .txt extention is visible, change this to .bat. It can also be done with "Save as".

 

 

 

 

 

2. Open Convert Entity to Text and add the line of text

for %%a in (GameInfo\*.entity) do ConvertData_Rebellion entity %%a %%a txt

 

Choose the "Save as" Command and be sure to change the .txt extension with the .bat extension. Convert Entity to TXT.png

If "Convert Entity to Text.txt" still exists in <reference data>, delete it now.

Example Reference Data folder

 

3. Double-Left-click or select "Convert Entity to Text.bat" and press [Enter] to activate the .bat file.

Wait for it to loop through and convert all the entity files to text format. The CMD window will disapear on completion.

Right-click --> Edit to view or modify a .bat file.

 

 

4. Repeat steps 1 and 2 following the table below to create all the necessary .bat files, or Download them.

Note: The 1st in the list should already be created in steps 1 and 2.

Select All > Download > Extract files to mod folder
Select All > Download > Extract files to mod folder
.bat file name Code
Convert Entity to Text for %%a in (GameInfo\*.entity) do ConvertData_Rebellion entity %%a %%a txt
Convert Entity to Bin for %%a in (GameInfo\*.entity) do ConvertData_Rebellion entity %%a %%a bin
Convert Mesh to Text for %%a in (Mesh\*.mesh) do ConvertData_Rebellion mesh %%a %%a txt
Convert Mesh to Bin for %%a in (Mesh\*.mesh) do ConvertData_Rebellion mesh %%a %%a bin
Convert Particle to Text for %%a in (Particle\*.particle) do ConvertData_Rebellion particle %%a %%a txt
Convert Particle to Bin for %%a in (Particle\*.particle) do ConvertData_Rebellion particle %%a %%a bin
Convert Brushes to Text    for %%a in (Window\*.brushes) do ConvertData_Rebellion brushes %%a %%a txt
Convert Brushes to Bin for %%a in (Window\*.brushes) do ConvertData_Rebellion brushes %%a %%a
Reference Data Dir2.png
Reference Data Dir2.png

 

  • Double-Left-click or select "Convert Particle to Text.bat" and press [Enter] to activate the .bat file. Wait for it to loop through and convert all the particle files to text format.
  • Double-Left-click or select "Convert Brushes to Text.bat" and press [Enter] to activate the .bat file. Wait for it to loop through and convert all the brushes files to text format.
  • "Convert Mesh to Text.bat" is optional. The next step will show how to covert a single mesh file.

 

 

 

 

 

Command Prompt

The XSI modeling tutorials use the Advent Light Frigate aka Frigate_PsiLight.mesh, this is the mesh file this tutorial will use.

 

Open the Command Prompt window

  • Win 10 Start --> Windows System --> Command Prompt
  • run CMD [Enter]

 

Change Directory cd to the loaction of <reference data>\ConvertData_Rebellion.exe

cd C:\Documents\My Games\Ironclad Games\Sins of a Solar Empire Rebellion\Mods-Rebellion v1.85 Dev\Reference Data

RTENOTITLE

 

ConvertData_Rebellion type FileName.type FileName.type txt [Enter]

ConvertData_Rebellion mesh Mesh\Frigate_PsiLight.mesh Mesh\Frigate_PsiLight.mesh txt

RTENOTITLE

RTENOTITLE

 

Convert the same file back to BIN format

ConvertData_Rebellion mesh Mesh\Frigate_PsiLight.mesh Mesh\Frigate_PsiLight.mesh bin

 

Other Text Modding Files

Copy the following directories that also contain modifiable files that can "Open with" a favorite text editor.

Reference Data Folders.png
Reference Data Folders.png
  • Font
  • Galaxy
  • PipelineEffect
  • String
  • TextureAnimations

 

Manifests

Copy the 6 manifest files

Manifests.png
Manifests.png

<Sins Path>\*.manifest to <reference data>\*.manifest

 

 


 

 

Modding Tools

Incude the tool directories with the <reference data>. Working from a mod folder has benifits and leaves the <Sins Path> intact.

Sins Modding Tools.png
Sins Modding Tools.png

RTENOTITLE

 

 

 

Check Game Integrity

Steam Properties Local.png
Steam Properties Local.png

Once all the files that are needed for modding are copied from <Sins Path>, it may be a good idea to check that all the files are in a good state.

 

Navigate to the Steam Library 

Locate Sins of a Solar Empire Rebellion

right-click --> Properties

Select the "LOCAL FILES" tab.

Click on "VERIFY INTEGRITY OF GAME CACHE..."

 

 

 

 

Archive and Upload

Archive the entire <reference data> directory and name the archive using the current version. This tutorials version is 1.85

Rebellion_1.85_Reference_Data.zip

 

 

modDB is a popular upload site. Join the Sins Modders group and you can upload an archive directly to the groups files section.

http://www.moddb.com/company/soase-m0dders/downloads