Convert Data: Difference between revisions

From Sins of a Solar Empire - Official Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:


= Introduction =
Starting to mod SoaSE first requires converting files from BIN format to TXT format. Once converted, the files can be edited with any text editor like notepad, I recommend Notepad++ (free). Using TXT files is fine, BIN file are used to help the game load faster and save a lot of space, basically a form of compression the game can read.<br/> <br/> '''Note:'''&nbsp;''The ConvertData files are version specific. The old ConvertData files included with Forge Tools 3 will not work with current files or the current ConvertData files will not convert older mod files.''<br/> <br/> Converting files will keep the same extension (e.g. *.entity). To open the converted files you will need to first specify a program to do so (e.g. notepad). The very first line upon opening the file will either read TXT or BIN.
 
&nbsp;
 
&nbsp;
 
= Batch Convert =
 
Using a simple .bat file along with the ConvertData_Rebellion.exe, converting multiple files becomes very easy.
 
&nbsp;
 
== Create a BAT File ==
 
'''[[File:ConvertData BATnew.png|right|300px|ConvertData BATnew.png|link=ConvertData BATnew.png]]Create'''&nbsp;a new text document on your desktop. Double click the&nbsp;'''file'''&nbsp;– it should be blank inside. Now, go to&nbsp;'''file'''>save as, and in the “Save As” window, input a name for your&nbsp;'''BAT file'''&nbsp;and then add a “.'''bat'''” on the end (without the quotes).
 
Once the .bat is created, double click to run. To view or modify,&nbsp;right-click --> Edit
 
By default, the ConvertData exes will convert to BIN so the bin switch at the end is not required. The next 2 examples are identical.
 
*for&nbsp;%%a in (*.'''''type''''') do ConvertData_Rebellion '''''type&nbsp;'''''%%a&nbsp;%%a&nbsp;<span style="color:#FF0000;">bin</span>
*for&nbsp;%%a in (*.'''''type''''') do ConvertData_Rebellion '''''type&nbsp;'''''%%a&nbsp;%%a
 
&nbsp;


Starting to mod SoaSE first requires converting files from BIN format to TXT format. Once converted, the files can be edited with any text editor like notepad, I recommend Notepad++ (free). Using TXT files is fine, BIN file are used to help the game load faster and save a lot of space, basically a form of compression the game can read.<br/> <br/> '''Note:'''&nbsp;''The ConvertData files are version specific. The old ConvertData files included with Forge Tools 3 will not work with current files or the current ConvertData files will not convert older mod files.''<br/> <br/> Converting files will keep the same extension (e.g. *.entity). To open the converted files you will need to first specify a program to do so (e.g. notepad). The very first line upon opening the file will either read TXT or BIN.
{| align="left" border="0" cellpadding="1" cellspacing="1"
|+ Convert File Types
|-
| GameInfo\*.entity to Text &nbsp; &nbsp;
| for&nbsp;%%a in (*.entity) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a txt
|-
| GameInfo\*.entity to Bin
| for&nbsp;%%a in (*.entity) do ConvertData_Rebellion entity&nbsp;%%a&nbsp;%%a
|-
| [[Modeling|Mesh]]\*.mesh to Text
| for&nbsp;%%a in (*.mesh) do ConvertData_Rebellion mesh&nbsp;%%a&nbsp;%%a txt
|-
| Mesh\*.mesh to Bin
| for&nbsp;%%a in (*.mesh) do ConvertData_Rebellion mesh&nbsp;%%a&nbsp;%%a
|-
| [[Particle_Forge|Particle]]\*.particle to Text
| for&nbsp;%%a in (*.particle) do ConvertData_Rebellion particle&nbsp;%%a&nbsp;%%a txt
|-
| [[Particle_Forge|Particle]]\*.particle to Bin
| for&nbsp;%%a in (*.particle) do ConvertData_Rebellion particle&nbsp;%%a&nbsp;%%a
|-
| Window\*.brushes to Text
| for&nbsp;%%a in (*.brushes) do ConvertData_Rebellion brushes&nbsp;%%a&nbsp;%%a&nbsp;txt
|-
| Window\*.brushes to Bin
| for&nbsp;%%a in (*.brushes) do ConvertData_Rebellion brushes&nbsp;%%a&nbsp;%%a
|}
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
&nbsp;
 
== Run a BAT File ==
 
Locate&nbsp;'''ConvertData_Rebellion.exe''' fron the '''Sins of a Solar Empire Rebellion''' install directory (e.g.&nbsp;''C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion'').
 
[[File:ConvertData BAT.png|right|ConvertData BAT.png]]Copy&nbsp;'''ConvertData_Rebellion.exe''' to the location which will be used to convert the files. The new mod folder is a good choice. Keep the&nbsp;'''ConvertData_Rebellion.exe&nbsp;'''and any new .bat files together for these codes to work.
 
Example Convert Entity folder inside a mods GameInfo folder.
 
C:\Documents\My Games\Ironclad Games\Sins of a Solar Empire Rebellion\Mods-Rebellion v1.85 Dev\Reference Files\GameInfo\Convert_Entity
 
Move a single entity file, or all of the ones required to convert into the same directory as the .bat files and the .exe. Double click the .bat file and wait for the batch to complete.


&nbsp;
&nbsp;
Line 8: Line 85:
&nbsp;
&nbsp;


= Required Files =
= Single File Method =


To keep all the modding files together, create&nbsp;a Developer folder in the&nbsp;C drive (e.g. C:\Developer). Inside the new folder, create&nbsp;a folder called ConvertData.<br/> <br/> Navigate to where SoaSE is installed&nbsp;<br/> (e.g. C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion)&nbsp;<br/> and Copy [Ctrl + C]<br/> <br/> ConvertData_Rebellion.exe<br/> <br/> Paste [Ctrl + V] the files in the ConvertData folder (e.g. C:\Developer\ConvertData). Note the short address location. This address will need to be typed at the DOS prompt so keep it short to avoid spelling errors. You can also use paste at the DOS prompt.
To keep all the modding files together, create&nbsp;a Developer folder in the&nbsp;C drive (e.g. C:\Developer). Inside the new folder, create&nbsp;a folder called ConvertData.<br/> <br/> Navigate to where SoaSE is installed&nbsp;<br/> (e.g. C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion)&nbsp;<br/> and Copy [Ctrl + C]<br/> <br/> ConvertData_Rebellion.exe<br/> <br/> Paste [Ctrl + V] the files in the ConvertData folder (e.g. C:\Developer\ConvertData). Note the short address location. This address will need to be typed at the DOS prompt so keep it short to avoid spelling errors. You can also use paste at the DOS prompt.
Line 16: Line 93:
&nbsp;
&nbsp;


= BIN to TXT =
== BIN to TXT ==


Navigate to the folder containing the BIN files, where SoaSE is installed or the mod folder e.g.<br/> <br/> C:\Program Files (x86)\Stardock Games\Sins of a Solar Empire - Trinity\GameInfo<br/> <br/> and COPY [Ctrl + C] the files which you choose to mod and paste them to the ConvertData folder.<br/> <br/> The 3 ConvertData exes are DOS programs and will need the Command Prompt window to use them.<br/> <br/> XP<br/> Navigate to Start --> Programs --> Accessories --> Command Prompt<br/> or type cmd [Enter]in the Start --> Run box.<br/> <br/> Vista and Win 7<br/> Navigate to Start --> All Programs --> Accessories --> Command Prompt<br/> or type cmd [Enter] in the Start --> Start Search box.<br/> <br/> Navigate to the ConvertData folder in DOS using the cd "Change Directory" command and address, this is not case sensitive. e.g.<br/> <br/> CD C:\Developer\ConvertData
Navigate to the folder containing the BIN files, where SoaSE is installed or the mod folder e.g.<br/> <br/> C:\Program Files (x86)\Stardock Games\Sins of a Solar Empire - Trinity\GameInfo<br/> <br/> and COPY [Ctrl + C] the files which you choose to mod and paste them to the ConvertData folder.<br/> <br/> The 3 ConvertData exes are DOS programs and will need the Command Prompt window to use them.<br/> <br/> XP<br/> Navigate to Start --> Programs --> Accessories --> Command Prompt<br/> or type cmd [Enter]in the Start --> Run box.<br/> <br/> Vista and Win 7<br/> Navigate to Start --> All Programs --> Accessories --> Command Prompt<br/> or type cmd [Enter] in the Start --> Start Search box.<br/> <br/> Navigate to the ConvertData folder in DOS using the cd "Change Directory" command and address, this is not case sensitive. e.g.<br/> <br/> CD C:\Developer\ConvertData
Line 47: Line 124:
&nbsp;
&nbsp;


= TXT to BIN =
== TXT to BIN ==


Once the mod is tested and everything is good you may want to help the game load quicker by converting the TXT files back to BIN format. This is the same as the process above accept for the TXT switch at the end of the command line.<br/> <br/> By default, the ConvertData exes will convert to BIN so the bin switch at the end is not required. The next 2 examples are identical.<br/> <br/> ConvertData_Rebellion&nbsp;'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;bin [Enter]<br/> <br/> ConvertData_Rebellion&nbsp;'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;[Enter]
Once the mod is tested and everything is good you may want to help the game load quicker by converting the TXT files back to BIN format. This is the same as the process above accept for the TXT switch at the end of the command line.<br/> <br/> By default, the ConvertData exes will convert to BIN so the bin switch at the end is not required. The next 2 examples are identical.<br/> <br/> ConvertData_Rebellion&nbsp;'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;bin [Enter]<br/> <br/> ConvertData_Rebellion&nbsp;'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;FileName.'''''type'''''&nbsp;[Enter]
Line 65: Line 142:
&nbsp;
&nbsp;


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

Revision as of 17:21, 29 September 2016

Starting to mod SoaSE first requires converting files from BIN format to TXT format. Once converted, the files can be edited with any text editor like notepad, I recommend Notepad++ (free). Using TXT files is fine, BIN file are used to help the game load faster and save a lot of space, basically a form of compression the game can read.

Note: The ConvertData files are version specific. The old ConvertData files included with Forge Tools 3 will not work with current files or the current ConvertData files will not convert older mod files.

Converting files will keep the same extension (e.g. *.entity). To open the converted files you will need to first specify a program to do so (e.g. notepad). The very first line upon opening the file will either read TXT or BIN.

 

 

Batch Convert

Using a simple .bat file along with the ConvertData_Rebellion.exe, converting multiple files becomes very easy.

 

Create a BAT File

ConvertData BATnew.png
ConvertData BATnew.png

Create a new text document on your desktop. Double click the file – it should be blank inside. Now, go to file>save as, and in the “Save As” window, input a name for your BAT file and then add a “.bat” on the end (without the quotes).

Once the .bat is created, double click to run. To view or modify, right-click --> Edit

By default, the ConvertData exes will convert to BIN so the bin switch at the end is not required. The next 2 examples are identical.

  • for %%a in (*.type) do ConvertData_Rebellion type %%a %%a bin
  • for %%a in (*.type) do ConvertData_Rebellion type %%a %%a

 

Convert File Types
GameInfo\*.entity to Text     for %%a in (*.entity) do ConvertData_Rebellion entity %%a %%a txt
GameInfo\*.entity to Bin for %%a in (*.entity) do ConvertData_Rebellion entity %%a %%a
Mesh\*.mesh to Text for %%a in (*.mesh) do ConvertData_Rebellion mesh %%a %%a txt
Mesh\*.mesh to Bin for %%a in (*.mesh) do ConvertData_Rebellion mesh %%a %%a
Particle\*.particle to Text for %%a in (*.particle) do ConvertData_Rebellion particle %%a %%a txt
Particle\*.particle to Bin for %%a in (*.particle) do ConvertData_Rebellion particle %%a %%a
Window\*.brushes to Text for %%a in (*.brushes) do ConvertData_Rebellion brushes %%a %%a txt
Window\*.brushes to Bin for %%a in (*.brushes) do ConvertData_Rebellion brushes %%a %%a

 

 

 

 

 

 

 

 

Run a BAT File

Locate ConvertData_Rebellion.exe fron the Sins of a Solar Empire Rebellion install directory (e.g. C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion).

ConvertData BAT.png
ConvertData BAT.png

Copy ConvertData_Rebellion.exe to the location which will be used to convert the files. The new mod folder is a good choice. Keep the ConvertData_Rebellion.exe and any new .bat files together for these codes to work.

Example Convert Entity folder inside a mods GameInfo folder.

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

Move a single entity file, or all of the ones required to convert into the same directory as the .bat files and the .exe. Double click the .bat file and wait for the batch to complete.

 

 

Single File Method

To keep all the modding files together, create a Developer folder in the C drive (e.g. C:\Developer). Inside the new folder, create a folder called ConvertData.

Navigate to where SoaSE is installed 
(e.g. C:\Program Files (x86)\Steam\steamapps\common\Sins of a Solar Empire Rebellion) 
and Copy [Ctrl + C]

ConvertData_Rebellion.exe

Paste [Ctrl + V] the files in the ConvertData folder (e.g. C:\Developer\ConvertData). Note the short address location. This address will need to be typed at the DOS prompt so keep it short to avoid spelling errors. You can also use paste at the DOS prompt.

 

 

BIN to TXT

Navigate to the folder containing the BIN files, where SoaSE is installed or the mod folder e.g.

C:\Program Files (x86)\Stardock Games\Sins of a Solar Empire - Trinity\GameInfo

and COPY [Ctrl + C] the files which you choose to mod and paste them to the ConvertData folder.

The 3 ConvertData exes are DOS programs and will need the Command Prompt window to use them.

XP
Navigate to Start --> Programs --> Accessories --> Command Prompt
or type cmd [Enter]in the Start --> Run box.

Vista and Win 7
Navigate to Start --> All Programs --> Accessories --> Command Prompt
or type cmd [Enter] in the Start --> Start Search box.

Navigate to the ConvertData folder in DOS using the cd "Change Directory" command and address, this is not case sensitive. e.g.

CD C:\Developer\ConvertData

CMD CD.png
CMD CD.png

There are 4 different types of files to convert.

  • brushes
  • entity
  • mesh
  • particle


To do each file separately from the selected expansion, use...
 

Rebellion

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

Trinity Versions

ConvertData_OriginalSins type FileName.type FileName.type txt [Enter]
ConvertData_Entrenchment type FileName.type FileName.type txt [Enter]
ConvertData_Diplomacy type FileName.type FileName.type txt [Enter]

Here is an example using AbilityEMPBlast.entity from the GameInfo directory.

ConvertData_Rebellion entity AbilityEMPBlast.entity AbilityEMPBlast.entity txt

 

If there was no error the file will be converted to TXT and the DOS prompt will return to the convert directory.

 

 

TXT to BIN

Once the mod is tested and everything is good you may want to help the game load quicker by converting the TXT files back to BIN format. This is the same as the process above accept for the TXT switch at the end of the command line.

By default, the ConvertData exes will convert to BIN so the bin switch at the end is not required. The next 2 examples are identical.

ConvertData_Rebellion type FileName.type FileName.type bin [Enter]

ConvertData_Rebellion type FileName.type FileName.type [Enter]

 

 

See also:

Convert Data Guide on Steam

Rebellion CovertData folders with .bat files