Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

Difference between revisions of "UE2:Using the UT2004 mod system"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
 
m
(One intermediate revision by one other user not shown)
Line 1: Line 1:
−
These [[Legacy:Basic Procedure|basic procedure]]s will show you how the unreal engine works with directories and how to setup your modification so it will use the '''mod system'''. This will keep your modification seperate to [[Legacy:UT2004|UT2004]] and allow you to work with greater ease and effiency on bigger mods. Personally I always use this as it keeps my base directory free from clutter although if you are working on something smaller like a mutator or gametype you may not need to use this. The best use for this is in '''total conversion''' situations where you modification will take up alot of room and have many [[Legacy:Package|package]]'s.
+
These basic procedures will show you how the unreal engine works with directories and how to setup your modification so it will use the '''mod system'''. This will keep your modification seperate to [[Legacy:UT2004|UT2004]] and allow you to work with greater ease and effiency on bigger mods. Personally I always use this as it keeps my base directory free from clutter although if you are working on something smaller like a mutator or gametype you may not need to use this. The best use for this is in '''total conversion''' situations where you modification will take up alot of room and have many [[Legacy:Package|package]]'s.
  
−
Say your [[Legacy:Base Directory|Base Directory]] is C:\ut2004\
+
The mod system is accessed through the use of
  
−
{{innerbox|'''your mod's''' directory structure would look like this:
+
'''ut2004.exe -mod="your mod"'''
  
−
C:\ut2004\'''YourMod'''\
+
'''ucc.exe -mod="your mod"'''
  
−
C:\ut2004\'''YourMod\MyModCode\'''          <&ndash; a UnrealScript package for your mod
+
'''unrealed.exe -mod="your mod"'''  
−
 
+
−
C:\ut2004\'''YourMod\MyModCode\Classes'''  <&ndash; put you source code here
+
−
 
+
−
C:\ut2004\'''YourMod\MyModGUI\'''          <&ndash; another UnrealScript Package
+
−
 
+
−
C:\ut2004\'''YourMod\MyModGUI\Classes'''
+
−
 
+
−
C:\ut2004\'''YourMod\System'''
+
−
 
+
−
}}
+
−
 
+
−
The mod system is accessed through the use of '''-mod=''' commandline switch
+
−
 
+
−
{{innerbox|C:\ut2004\ut2004.exe -mod='''your mod'''
+
−
 
+
−
C:\ut2004\ucc.exe -mod='''your mod'''
+
−
 
+
−
C:\ut2004\unrealed.exe -mod='''your mod'''
+
−
 
+
−
}}
+
−
+
  
 
I have found that in unreal ed it does not default to '''your mod's''' directories, so keep an eye on that when saving anything from maps or packages. If there is a way to fix this please let me know.
 
I have found that in unreal ed it does not default to '''your mod's''' directories, so keep an eye on that when saving anything from maps or packages. If there is a way to fix this please let me know.
Line 36: Line 15:
 
[[Legacy:Engine_Directory_Structure|Engine_Directory_Structure]] - First we'll start with a rundown of the unreal engines directory structure.
 
[[Legacy:Engine_Directory_Structure|Engine_Directory_Structure]] - First we'll start with a rundown of the unreal engines directory structure.
  
−
[[Legacy:Set_Up_Package_Folders|Set_Up_Package_Folders]] - Then we examine how to setup [[Legacy:Package|package]]'s so you can compile, '''Not really related to mod system'''
+
[[Legacy:Set_Up_Package_Folders|Set_Up_Package_Folders]] - Then we examine how to setup [[Legacy:Package|package]]'s so you can compile.
  
 
[[Legacy:UT2k4Mod.Ini|UT2k4Mod.Ini]] - We start to get into how to setup '''your mod''' to be accessed from the community panel in [[Legacy:UT2004|UT2004]].
 
[[Legacy:UT2k4Mod.Ini|UT2k4Mod.Ini]] - We start to get into how to setup '''your mod''' to be accessed from the community panel in [[Legacy:UT2004|UT2004]].
Line 43: Line 22:
  
 
[[Legacy:Compiling_With_UCC|Compiling_With_UCC]] - Lastly to round things off we take a look at how to compile using '''ucc.exe'''
 
[[Legacy:Compiling_With_UCC|Compiling_With_UCC]] - Lastly to round things off we take a look at how to compile using '''ucc.exe'''
−
 
−
====Log File====
 
−
 
−
{{innerbox|When running with mod support, the main .log files will be placed in your mod's System directory by default and be called <ModNamer>.Log (ie: MyMod.log). All other secondary log files (such as ucc.log) will still be created in the game's System directory.
 
−
 
−
}}
 
  
 
===Intermediate===
 
===Intermediate===
  
−
[[Legacy:Commandlet|Commandlet]]s can be very useful to UScripters, providing automated tasks so you dont have to repetativly do things by hand, The Export Cache [[Legacy:Commandlet|commandlet]] is one example of this. These can also be used to provide language support for various nations.
+
Commandlets can be very useful to UScripters, providing automated tasks so you dont have to repetativly do things by hand, The Export Cache commandlet is one example of this. These can also be used to provide language support for various nations.
  
−
{{innerbox|Starting with the latest patch, UT2004 can correctly locate and use .int and .ucl files stored in your mod's System directory (or in the case of .ucl whichever directory is specified by the CacheRecordPath array). But, it does require some work on your part.
+
[[Legacy:DumpIntCommandlet|DumpIntCommandlet]]
  
−
}}
+
[[Legacy:ExportCacheCommandlet|ExportCacheCommandlet]]
−
 
+
−
====DumpInt====
+
−
 
+
−
[[Legacy:DumpIntCommandlet|DumpIntCommandlet]] - will always create the new .int files in the game's System directory. This is an unfortunate outcome, but changing it would have proven difficult at this time.
+
−
 
+
−
====ExportCache====
+
−
 
+
−
[[Legacy:ExportCacheCommandlet|ExportCacheCommandlet]] - will create the .ucl files in the first directory found in the CacheRecordPath array. Using the trick above, you can force it to use your directory, but that’s un supported. As a general rule, you will have to hand copy these files in to their proper place. Sorry.
+
  
 
===Custom Characters===
 
===Custom Characters===
  
 
You may want to add custom characters or even custom species type to your total conversion, lucky there is a simple way to set it up. Its called the Unreal Player List.
 
You may want to add custom characters or even custom species type to your total conversion, lucky there is a simple way to set it up. Its called the Unreal Player List.
−
 
−
{{innerbox|There is special logic built in to the latest patch to make UPL files mod friendly. It works as follows:
 
−
 
−
When the cache manager searches for UPL files, it traverses the Paths array in reverse (bottom to top) and it checks either directory for .UPL files >adding any it finds to it’s cache. When it reaches the game's System, the following occurs:
 
−
 
−
1.If you are not running with a mod, it will scan the directory as normal.
 
−
 
−
2.If you are running a mod, no .upl files have been found already, it will scan the directory as normal.
 
−
 
−
3.If you are running a mod, and the game has already found even a single .upl file, it will skip the default System directory.
 
−
 
−
In a nutshell, this means that if you have a mod that uses both your own custom .upl files and you want to allow them to use the default characters, you will need to include a copy of the original .upl files with your mod.
 
−
 
−
}}
 
  
 
[[Legacy:UPL_File|UPL_File]]
 
[[Legacy:UPL_File|UPL_File]]
Line 96: Line 47:
 
===External Links and Other useful Links===
 
===External Links and Other useful Links===
  
−
[[udn2:ImprovedModSupport]]
+
[[udn2:ImprovedModSupport#IMPROVED_MOD_SUPPORT]]
  
 
http://geeks.beyondunreal.com/ut2004/docs-modsystem.php
 
http://geeks.beyondunreal.com/ut2004/docs-modsystem.php

Revision as of 20:15, 28 March 2006

These basic procedures will show you how the unreal engine works with directories and how to setup your modification so it will use the mod system. This will keep your modification seperate to UT2004 and allow you to work with greater ease and effiency on bigger mods. Personally I always use this as it keeps my base directory free from clutter although if you are working on something smaller like a mutator or gametype you may not need to use this. The best use for this is in total conversion situations where you modification will take up alot of room and have many package's.

The mod system is accessed through the use of

ut2004.exe -mod="your mod"

ucc.exe -mod="your mod"

unrealed.exe -mod="your mod"

I have found that in unreal ed it does not default to your mod's directories, so keep an eye on that when saving anything from maps or packages. If there is a way to fix this please let me know.

Basic Setup

Engine_Directory_Structure - First we'll start with a rundown of the unreal engines directory structure.

Set_Up_Package_Folders - Then we examine how to setup package's so you can compile.

UT2k4Mod.Ini - We start to get into how to setup your mod to be accessed from the community panel in UT2004.

UT2k4 Default.Ini - This will show you how to setup your mod's default.ini file so you can use it to compile.

Compiling_With_UCC - Lastly to round things off we take a look at how to compile using ucc.exe

Intermediate

Commandlets can be very useful to UScripters, providing automated tasks so you dont have to repetativly do things by hand, The Export Cache commandlet is one example of this. These can also be used to provide language support for various nations.

DumpIntCommandlet

ExportCacheCommandlet

Custom Characters

You may want to add custom characters or even custom species type to your total conversion, lucky there is a simple way to set it up. Its called the Unreal Player List.

UPL_File

Defining_SpeciesTypes

Advanced Importing

When working with large amounts of assets it might be alittle overwhelming to do this by hand through unrealed. Now alot of the time unrealed will let you import multiple files at once but sometimes it is much easier done on the command line. It free's up valuable memory that can be used to get the process done quicker without the overhead of the full editor open.

Exec_Directive

External Links and Other useful Links

udn2:ImprovedModSupport#IMPROVED_MOD_SUPPORT

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

Making_Mods

Mod_Authoring

Discussion

OlympusMons:Ok so I created this page to pull all the mod system stuff together into a format I can use to make a tutorial. Alot of it is in basic prodecure type pages but I think it'll work very well like that. Im going to work a bit more on this page dont worry, if there is another page on this topic and I missed it please let me know and I'll give this a deleteme. Im hoping to add it to the UnrealScript_Lessons page when Im finsihed.

Retrieved from "https://wiki.beyondunreal.com/UE2:Using_the_UT2004_mod_system?oldid=9056"