| Revision as of 04:11, 2 February 2012 Armorwraith (Talk | contribs) Required Folders and Files for our Mod: ← Previous diff |
Current revision Armorwraith (Talk | contribs) Required Folders and Files for our Mod: |
||
| Line 1: | Line 1: | ||
| =Mod File Structure= | =Mod File Structure= | ||
| - | Mods have a pre-arranged file structure that they must adhere to. Basically we as the developer are showing the engine where to look for game resources, be it sound effects, textures, landscapes, or models. The data folder contains all the information our mod needs to function properly. | + | Mods have a pre-arranged file structure that they must adhere to. Basically we as the developer are showing the engine where to look for game resources, be it sound effects, code, textures, landscapes, or models. The data folder contains all the information our mod needs to function properly. |
| ==Creating the Data Folder:== | ==Creating the Data Folder:== | ||
| Line 26: | Line 26: | ||
| ==Required Folders and Files for our Mod:== | ==Required Folders and Files for our Mod:== | ||
| - | The following files need to be created and inserted into our mods data folder. | + | The following "folders" need to be created and inserted into our mods "data" folder: |
| - | *Create an "accessories" folder | + | *[[file&folderdescrip#Accessories Folder|Create an "accessories" folder]] |
| - | *Create a "landscapes" folder | + | *[[file&folderdescrip#Landscapes Folder|Create a "landscapes" folder]] |
| - | *Create an "lua" folder | + | *[[file&folderdescrip#LUA Folder|Create an "lua" folder]] |
| - | *Create a "meshes" folder | + | *[[file&folderdescrip#Meshes Folder|Create a "meshes" folder]] |
| - | *Create a "music" folder | + | *[[file&folderdescrip#Music Folder|Create a "music" folder]] |
| - | *Create a "talk" folder | + | *[[file&folderdescrip#Talk Folder|Create a "talk" folder]] |
| - | *Create a "tanks" folder | + | *[[file&folderdescrip#Tanks Folder|Create a "tanks" folder]] |
| - | *Create a "textures" folder | + | *[[file&folderdescrip#Textures Folder|Create a "textures" folder]] |
| - | *Create a "wav" folder | + | *[[file&folderdescrip#WAV Folder|Create a "wav" folder]] |
| - | *Create a "windows" folder | + | *[[file&folderdescrip#Windows Folder|Create a "windows" folder]] |
| - | <center><b><font size=2><font color=#ffac53>Reminder: To create a new folder, right click and select new folder.</font color></font size></b></center> | + | <b><font size=2><font color=#ffac53>Reminders:</font color></font size></b><font color=#ffac53> |
| - | <center><b><font size=2><font color=#ffac53>Reminder:Check your spelling carefully, your mod will not function with incorrect spelling in the folder name, or capital letters.</font color></font size></b></center> | + | *To create a new folder, right click and select new folder. |
| + | *Check your folder spelling carefully, or your mod will not function properly. | ||
| + | *Do not use capital letters. | ||
| + | *Click on any of the above links for a detailed description of its purpose. | ||
| + | </font color> | ||
| + | |||
| + | Next we need to add various "TEXT" and "XML" files using our preffered text editor. I will be using ConTEXT for basic examples within this guide.<BR> | ||
| + | |||
| + | <b><font size=2><font color=#ffac53>Reminder:</font color></font size></b><font color=#ffac53>[[Armor_Modding_Tools|General Modding Tools: Text Editor]]</font color> | ||
| + | |||
| + | The following "TEXT" files can be created and inserted into our mods "data" folder but they are not required: | ||
| + | *[[textfileainames|"ainames.txt"]] | ||
| + | *[[textfileplayernames|"playernames.txt"]] | ||
| + | |||
| + | |||
| + | At this point our data folder in myfirstmod folder should look like this when we open it.<BR> | ||
| + | <center>http://www.scorched3d.co.uk/phpBB3/download/file.php?id=4962/folder&txt.png</center><BR> | ||
| + | |||
| + | If your folder matches the above setup exactly CONGRATULATIONS!! You're ready to enter part two of mod file structure! In part two we will focus on adding XML files and exploring their capabilities! <BR> | ||
| + | <BR> | ||
| + | To continue to the next phase in mod structure please click here: | ||
| + | |||
| + | <center><b><font size=5><font color=#ffac53>[[Mod_File_Architecture_part2| Mod File-Structure Part 2]]</font color></font size></b> | ||
| + | </center> | ||
Mods have a pre-arranged file structure that they must adhere to. Basically we as the developer are showing the engine where to look for game resources, be it sound effects, code, textures, landscapes, or models. The data folder contains all the information our mod needs to function properly.
So far your setup should look similar to this depending on your operating system and username. Below is an example using windows seven:

The next step will be to add the necessary files and folders inside our data folder.
Now we need to add a couple files and folders:
The following "folders" need to be created and inserted into our mods "data" folder:
Reminders:
Next we need to add various "TEXT" and "XML" files using our preffered text editor. I will be using ConTEXT for basic examples within this guide.
Reminder:General Modding Tools: Text Editor
The following "TEXT" files can be created and inserted into our mods "data" folder but they are not required:
At this point our data folder in myfirstmod folder should look like this when we open it.

If your folder matches the above setup exactly CONGRATULATIONS!! You're ready to enter part two of mod file structure! In part two we will focus on adding XML files and exploring their capabilities!
To continue to the next phase in mod structure please click here:
Mod File-Structure Part 2