Mostly Harmless

Difference between revisions of "UE2:UT2004 Default.ini"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
 
m
(One intermediate revision by the same user not shown)
Line 13: Line 13:
 
[[Legacy:Compiling With UCC|Compiling With UCC]]
 
[[Legacy:Compiling With UCC|Compiling With UCC]]
  
−
A few things before we start:
+
To compile your mod using the '''-mod=''' switch you must first create a '''Default.ini''' in your '''UT2k4Dir\ModRootDir\System'''. I have provided a template below. Replace mod with your mods directory, please be consistant. Also replace mod packages with your own.
−
*'''UT2k4Dir''' = The Directory where your copy of Unreal Tournament 2004 exists. for eg ''C:\ut2004\''
+
−
*'''ModRootDir''' = Your Modification Directory, This will be located in your '''UT2k4Dir'''.
+
−
 
+
−
To compile your mod using the '''-mod=''' switch you must first create a ''Default.ini'' in your '''UT2k4Dir\ModRootDir\System'''.
+
−
 
+
−
I have provided this template below as a guide, to use it simply replace '''mod''' with your modification's directory, please be consistant. Also replace the mod '''ModServerPackage''' and the '''ModEditPackage''' packages with your own, you do not need to replace server packages if you arn't going to use your mod online. You can use more than one package in this file just replicate the '''ServerPackages=''' and/or '''EditPackages=''' as many times is needed.
+
  
 
{{innerbox|;[Core.System]
 
{{innerbox|;[Core.System]
Line 50: Line 44:
  
 
}}
 
}}
−
*:When you compile or run with the '''-mod=''' switch this '''Default.ini''' file will be merged with the current '''UT2004.ini''' in your '''UT2k4Dir''' and a new ini file will be created in your '''ModRootDir\System''' and will have the same name as the '''ModDir'''.  
+
*Whats going on?
−
*The '''+''' and '''-''' are operators (Reffered to on UDN as modifiers) these are used to add and subtract Keys ([[Legacy:Dynamic Array|Dynamic Array]]'s) like Paths,ServerPackages,EditPackages from the current '''ut2004.ini'''.  
+
**:When you compile or run with the '''-mod=''' switch this '''Default.ini''' file will be merged with the current '''UT2004.ini''' in your '''UT2k4Dir''' and a new ini file will be created in your '''ModRootDir\System''' and will have the same name as the '''ModDir'''.  
−
*If no operator exists, one of two things will happen. If the key already exists the value of the key will be overwritten by the new value. If the key does not exist, the key and value will be added.
+
**The '''+''' and '''-''' are operators (Reffered to on UDN as modifiers) used to add and subtract Keys ([[Legacy:Dynamic Array|Dynamic Array]]'s) like Paths,ServerPackages,EditPackages from the current '''ut2004.ini'''.  
−
*Using the ''';''' before a key or operator will add the key to the ini but it will be commented out. So you can add values that you may use but dont use often etc and remove the ''';''' from your '''Mod.ini'''
+
**If no operator exists, one of two things will happen. If the key already exists the value of the key will be overwritten by the new value. If the key does not exist, the key and value will be added.
−
*If no '''ut2004.ini''' is present the resultant ini file will be created from merging '''default.ini''' in the '''UT2k4Dir''' and the one from '''ModRootDir'''.
+
**If no '''ut2004.ini''' is present the resultant ini file will be created from merging '''default.ini''' in the '''UT2k4Dir''' and the one from '''ModRootDir'''.
−
*'''-Paths=../Textures/.utx''' – This for example, would remove the original texture package directory from the resultant '''Mod.ini''' File.
+
**'''-Paths=../Textures/.utx''' – This for example, would remove the original texture package directory from the resultant '''Mod.ini''' File.
−
*Keys get processed in the order they appear, This can be useful as in the following:
+
**Keys get processed in the order they appear, This can be useful as in the following:
  
 
{{innerbox|'''-CacheRecordPath=../System/*.ucl'''
 
{{innerbox|'''-CacheRecordPath=../System/*.ucl'''
Line 65: Line 59:
  
 
}}
 
}}
−
*This is actually recommended because all cache files will be placed in the first '''CacheRecordPath''' found. Since this removes the '''CacheRecordPath''' used by UT2k4 then inserts the mods '''CacheRecordPath''' followed by the UT2k4 one this means the mods Path will appear before UT2k4's in our '''Mod.ini'''.
+
**This is actually recommended because all cache files will be placed in the first '''CacheRecordPath''' found. Since this removes the '''CacheRecordPath''' used by UT2k4 then inserts the mods '''CacheRecordPath''' followed by the UT2k4 one this means the mods Path will appear before UT2k4's in our '''Mod.ini'''.
−
 
+
**Another good technique for speeding compile times is to use and for supressing packages in the '''Mod.ini'''.
−
*Another good technique for speeding compile times is to use and for supressing packages in the '''Mod.ini'''. This technique can be used for any key.
+
  
 
{{innerbox|'''-EditPackages=UT2k4Package'''  
 
{{innerbox|'''-EditPackages=UT2k4Package'''  
Line 73: Line 66:
 
'''+;EditPackages=UT2k4Package"'''
 
'''+;EditPackages=UT2k4Package"'''
  
−
''';+EditPackages=UT2k4Package"'''
+
}}
 +
**This teqnique can be used in both '''[Engine.GameEngine]''' and '''[Editor.EditorEngine]'''
  
−
}}
 
 
*;Notes
 
*;Notes
 
**When running with '''-mod=''' switch, the main *.log file will by default be placed in your "ModRootDir\System" directory and be called '''Mod.log'''. All other secondary log files (such as ucc.log) will still be created in the UT2k4's system directory.
 
**When running with '''-mod=''' switch, the main *.log file will by default be placed in your "ModRootDir\System" directory and be called '''Mod.log'''. All other secondary log files (such as ucc.log) will still be created in the UT2k4's system directory.
 
**Ut2k4 will find karma(*.ka) and deafult player(*.upl) Files automatically when using the '''-mod=''' Switch.
 
**Ut2k4 will find karma(*.ka) and deafult player(*.upl) Files automatically when using the '''-mod=''' Switch.
−
**Trying to modify the '''UT2k4\SaveDir'''will make the game crash instead you can set UT2K4SP_Main.default.ProfilePrefix="Mod_" and it will keep you save games seperate from in the '''ModRootDir\Saves''' dir.'''-Paths=../Saves/*.uvx'''
 
−
**For '''*.upl''' files Ive found if you have your mods system directory before your ut2004 one it will not use the files located in the ut2004\system directory, it instead uses only the ones found in the ''mod system directory''.
 
−
 
−
*Things not to do when creating a '''deafult.ini'''
 
 
**You have been able to change the MusicPath since 3204. Since Beta 3229+ MusicPath has become an Array and you can set it up like:  
 
**You have been able to change the MusicPath since 3204. Since Beta 3229+ MusicPath has become an Array and you can set it up like:  
  
Line 92: Line 81:
  
 
}}
 
}}
 +
**Trying to modify the '''UT2k4\SaveDir'''will make the game crash instead you can set UT2K4SP_Main.default.ProfilePrefix="Mod_" and it will keep you save games seperate from in the '''ModRootDir\Saves''' dir.'''-Paths=../Saves/*.uvx'''
  
 
==Links==
 
==Links==
Line 104: Line 94:
 
http://udn.epicgames.com/Two/ImprovedModSupport#IMPROVED_MOD_SUPPORT
 
http://udn.epicgames.com/Two/ImprovedModSupport#IMPROVED_MOD_SUPPORT
  
−
==Discussion==
+
http://geeks.beyondunreal.com/ut2004/docs-modsystem.php
−
 
+
−
'''OlympusMons:''' Ok so Im going to fix this up a bit so it works better with my new page on the [[Legacy:Using_the_Mod_System_in_UT2004|Using_the_Mod_System_in_UT2004]].
+

Revision as of 23:51, 19 October 2005

Default.ini File in your UT2k4 Dir

Contains settings which are used for creating the UT2004.ini on your first run of the game. Thats why you'll find this file is very similar to UT2004.ini].

The Default.ini is also used when creating a mod using the mod system included with UT2k4.This file will contains all links required to run custom content in your modification using the -mod= switch. Although use of the mod system is not required it is recommended.

Using Default.ini to Compile with mod Support.

Recommended reading: Before getting started.

Set Up Package Folders

Compiling With UCC

To compile your mod using the -mod= switch you must first create a Default.ini in your UT2k4Dir\ModRootDir\System. I have provided a template below. Replace mod with your mods directory, please be consistant. Also replace mod packages with your own.

The innerbox template is only supposed to be used by the converted content imported into the Legacy: namespace. You might be looking for the Quote template instead.
The innerbox template is only supposed to be used by the converted content imported into the Legacy: namespace. You might be looking for the Quote template instead.
  • Whats going on?
    • When you compile or run with the -mod= switch this Default.ini file will be merged with the current UT2004.ini in your UT2k4Dir and a new ini file will be created in your ModRootDir\System and will have the same name as the ModDir.
    • The + and - are operators (Reffered to on UDN as modifiers) used to add and subtract Keys (Dynamic Array's) like Paths,ServerPackages,EditPackages from the current ut2004.ini.
    • If no operator exists, one of two things will happen. If the key already exists the value of the key will be overwritten by the new value. If the key does not exist, the key and value will be added.
    • If no ut2004.ini is present the resultant ini file will be created from merging default.ini in the UT2k4Dir and the one from ModRootDir.
    • -Paths=../Textures/.utx – This for example, would remove the original texture package directory from the resultant Mod.ini File.
    • Keys get processed in the order they appear, This can be useful as in the following:
The innerbox template is only supposed to be used by the converted content imported into the Legacy: namespace. You might be looking for the Quote template instead.
    • This is actually recommended because all cache files will be placed in the first CacheRecordPath found. Since this removes the CacheRecordPath used by UT2k4 then inserts the mods CacheRecordPath followed by the UT2k4 one this means the mods Path will appear before UT2k4's in our Mod.ini.
    • Another good technique for speeding compile times is to use and for supressing packages in the Mod.ini.
The innerbox template is only supposed to be used by the converted content imported into the Legacy: namespace. You might be looking for the Quote template instead.
    • This teqnique can be used in both [Engine.GameEngine] and [Editor.EditorEngine]
  • Notes
    • When running with -mod= switch, the main *.log file will by default be placed in your "ModRootDir\System" directory and be called Mod.log. All other secondary log files (such as ucc.log) will still be created in the UT2k4's system directory.
    • Ut2k4 will find karma(*.ka) and deafult player(*.upl) Files automatically when using the -mod= Switch.
    • You have been able to change the MusicPath since 3204. Since Beta 3229+ MusicPath has become an Array and you can set it up like:
The innerbox template is only supposed to be used by the converted content imported into the Legacy: namespace. You might be looking for the Quote template instead.
    • Trying to modify the UT2k4\SaveDirwill make the game crash instead you can set UT2K4SP_Main.default.ProfilePrefix="Mod_" and it will keep you save games seperate from in the ModRootDir\Saves dir.-Paths=../Saves/*.uvx

Links

External Links

http://udn.epicgames.com/Two/ImprovedModSupport#IMPROVED_MOD_SUPPORT

http://geeks.beyondunreal.com/ut2004/docs-modsystem.php

Retrieved from "https://wiki.beyondunreal.com/UE2:UT2004_Default.ini?oldid=8998"