|
|
| (28 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| Author: Leon
| | UCC is a command line utility for early Unreal engine games. Star Wars: Republic Commando ships without one, but a custom one has been made available as a result of reverse engineering. |
|
| |
|
| Used Tools: [[MS Visual Studio 2003]] | | Description: A custom UCC.exe for Republic Commando. Used for executing Unreal Commandlets. |
|
| |
|
| Description: A self written UCC for Republic Commando. Used for executing Unreal Commandlets.
| | Latest Build: [https://github.com/SWRC-Modding/CT/releases here] |
|
| |
|
| Github: [https://github.com/Leon280698/Republic-Commando-UCC here]
| |
|
| |
|
| Latest Build: [http://www.moddb.com/games/star-wars-republic-commando/downloads/star-wars-republic-commando-ucc-exe here]
| | [[File:Uccshow.PNG]] |
|
| |
|
| | ===== Batchexport Commandlet ===== |
|
| |
|
| ==UCC.cpp==
| | The batchexport commandlet is made available by UCC. This commandlet can parse the game's resource archives in order to export any exportable type in bulk. Here is the syntax for converting some texture package, called "exampletexturepackage.utx" from the game into a set of tga files in ExampleOutputFolder: |
|
| |
|
| <source lang="cpp" line"> | | '''<sup>./ucc.exe batchexport exampletexturepackage.utx texture tga ".\\ExampleOutputFolder"</sup>''' |
| /* | |
| * This code compiles to a dll. In order to use it, SWRepublicCommando.exe needs to be modified so
| |
| * that it calls this dll's 'uccInit' instead of 'appInit' from Core.dll
| |
| * Also it's subsystem should be changed from window to console
| |
| * Everything compiles fine with Visual Studio .NET 2003 which is being used to get maximum compatibility
| |
| * since it was also used to compile Republic Commando
| |
| * The following settings are required in order to compile everything without errors:
| |
| * - Character Set = Not Set
| |
| * - Struct Member Alignment = 4 Bytes
| |
| * - Calling Convention = __fastcall
| |
| */
| |
|
| |
|
| #pragma comment(lib, "Core.lib")
| | In particular, UCC can extract batches of sounds from the UAX archives where Republic Commando's voice lines and sound effects are stored. The batchexport commandlet does this. See [[Extract_Game_Audio_Using_UCC|how to extract game audio using UCC]] for details. |
| #pragma comment(lib, "Engine.lib")
| |
| | |
| #include <Windows.h> //VirtualProtect
| |
| | |
| #include <cstdio> //std::puts
| |
| #include <cstdlib> //__argc, __argv
| |
| #include <cctype> //std::toupper
| |
| #include <string>
| |
| | |
| #include "Engine/inc/Engine.h"
| |
| | |
| namespace{
| |
| //Global variables
| |
| | |
| FOutputDevice* GFileLog; //OutputDevice that writes to a log file
| |
| | |
| //All commandlets shipped with RC
| |
| const char* DefaultCommandlets[40][2] = {
| |
| {"Editor", "AnalyzeContent"},
| |
| {"Editor", "BatchExport"},
| |
| {"Editor", "ChecksumPackage"},
| |
| {"Editor", "CheckUnicode"},
| |
| {"Editor", "CompareInt"},
| |
| {"IpDrv", "Compress"},
| |
| {"Editor", "CompressToDXT"},
| |
| {"Editor", "Conform"},
| |
| {"Editor", "ConvertMaterial"},
| |
| {"Editor", "CutdownContent"},
| |
| {"Editor", "DataRip"},
| |
| {"IpDrv", "Decompress"},
| |
| {"XGame", "DumpGameList"},
| |
| {"Editor", "DumpInt"},
| |
| {"XGame", "DumpMapList"},
| |
| {"XGame", "DumpMutatorList"},
| |
| {"Editor", "DumpSoundParams"},
| |
| {"Editor", "DumpSoundPropLog"},
| |
| {"XGame", "DumpWeaponList"},
| |
| {"Editor", "DXTConvert"},
| |
| {"Editor", "Exec"},
| |
| {"Editor", "FontUpdate"},
| |
| {"Core", "HelloWorld"},
| |
| {"Editor", "ImportAse"},
| |
| {"Editor", "ImportTexture"},
| |
| {"Editor", "ListPackageContents"},
| |
| {"Editor", "Make"},
| |
| {"Editor", "MapConvert"},
| |
| {"Editor", "Master"},
| |
| {"Editor", "MergeInt"},
| |
| {"Editor", "ModifyPackageFlags"},
| |
| {"Editor", "PackageFlag"},
| |
| {"Editor", "Pkg"},
| |
| {"Editor", "RearrangeInt"},
| |
| {"Editor", "ResavePackage"},
| |
| {"Engine", "Server"},
| |
| {"Editor", "StripSource"},
| |
| {"Editor", "TestMath"},
| |
| {"Editor", "UpdateUMod"},
| |
| {"Editor", "XACTExport"}
| |
| };
| |
| | |
| //Helper function used for case-insensitive string comparisons
| |
| std::string ToUpper(const std::string& s){
| |
| std::string result;
| |
| | |
| result.reserve(s.size());
| |
| | |
| for(std::size_t i = 0; i < s.size(); i++)
| |
| result += std::toupper(s[i]);
| |
| | |
| return result;
| |
| }
| |
| | |
| /*
| |
| * Replacement for Serialize function of 'InWarn', passed to appInit
| |
| * Have to do this vtable hack because creating new FFeedbackContext and passing it results in crash
| |
| */
| |
| void __stdcall FFeedbackContextAnsiSerialize(const TCHAR* V, EName Event){
| |
| TCHAR Temp[1024]= "";
| |
| | |
| if(Event==NAME_Title){
| |
| return;
| |
| }else if(Event==NAME_Heading){
| |
| appSprintf(Temp, "\n--------------------%s--------------------", V);
| |
| | |
| V = Temp;
| |
| }else if(Event==NAME_SubHeading){
| |
| appSprintf(Temp, "%s...", V);
| |
| | |
| V = Temp;
| |
| }else if(Event == NAME_Error || Event == NAME_Warning || Event == NAME_ExecWarning || Event == NAME_ScriptWarning || Event == NAME_Critical){
| |
| appSprintf(Temp, "%s: %s", *FName(Event), V);
| |
| | |
| V = Temp;
| |
| }
| |
| | |
| std::puts(V);
| |
| | |
| GFileLog->Serialize(V, Event);
| |
| }
| |
| | |
| /*
| |
| * Replacement for UServerCommandlet::Main since the one from Engine.dll crashes because it doesn't assign a value to GEngine
| |
| */
| |
| void UServerCommandletMain(){
| |
| // Create the editor class.
| |
| UClass* EngineClass = UObject::StaticLoadClass(UEngine::StaticClass(), NULL, "Engine.GameEngine", NULL, LOAD_NoFail, NULL);
| |
| GEngine = ConstructObject<UEngine>(EngineClass);
| |
| GEngine->Init();
| |
| | |
| // Main loop.
| |
| GIsRunning = 1;
| |
| DOUBLE OldTime = appSeconds();
| |
| | |
| while(GIsRunning && !GIsRequestingExit){
| |
| // Update the world.
| |
| DOUBLE NewTime = appSeconds();
| |
| GEngine->Tick(NewTime - OldTime);
| |
| OldTime = NewTime;
| |
| | |
| // Enforce optional maximum tick rate.
| |
| FLOAT MaxTickRate = GEngine->GetMaxTickRate();
| |
| | |
| if( MaxTickRate > 0.0f ){
| |
| FLOAT Delta = (1.0f / MaxTickRate) - (appSeconds() - OldTime);
| |
| appSleep(Delta > 0.0f ? Delta : 0.0f);
| |
| }
| |
| }
| |
| }
| |
| }
| |
| | |
| //Entry point, called by modified SWRepublicCommando.exe
| |
| __declspec(dllexport) void uccInit(const TCHAR* InPackage, const TCHAR* InCmdLine, FOutputDevice* InLog, FOutputDeviceError* InError,
| |
| FFeedbackContext* InWarn, FConfigCache*(*ConfigFactory)(), UBOOL RequireConfig){
| |
| int ExitVal = EXIT_SUCCESS;
| |
|
| |
| GFileLog = InLog;
| |
| | |
| //vtable hack to have InWarn call my own Serialize function
| |
| //===============================================================
| |
| PVOID* vtable = *reinterpret_cast<PVOID**>(InWarn);
| |
| DWORD dwNull;
| |
| | |
| VirtualProtect(&vtable[0], 4, PAGE_EXECUTE_READWRITE, &dwNull);
| |
| | |
| vtable[0] = FFeedbackContextAnsiSerialize;
| |
| //===============================================================
| |
| | |
| InWarn->Log("=======================================");
| |
| InWarn->Log("ucc.exe for Star Wars Republic Commando");
| |
| InWarn->Log("made by Leon0628");
| |
| InWarn->Log("=======================================\n");
| |
| | |
| try{
| |
| GIsStarted = 1;
| |
| GIsGuarded = 1;
| |
| | |
| appInit(InPackage, InCmdLine, InLog, InError, InWarn, ConfigFactory, 1);
| |
| UObject::SetLanguage("int");
| |
| | |
| if(__argc > 1){
| |
| //Initializing global state
| |
| GIsUCC = GIsClient = GIsServer = GIsEditor = GIsScriptable = GLazyLoad = 1;
| |
| | |
| std::string Token = ToUpper(__argv[1]);
| |
| std::string ClassName = Token;
| |
| DWORD LoadFlags = LOAD_NoWarn | LOAD_Quiet;
| |
| | |
| //Looking it up in list of default commandlets
| |
| for(int i = 0; i < ARRAY_COUNT(DefaultCommandlets); i++){
| |
| if(Token == ToUpper(DefaultCommandlets[i][1]) || //Name
| |
| Token == ToUpper(DefaultCommandlets[i][1]) + "COMMANDLET"){ //Name + "Commandlet"
| |
|
| |
| ClassName = std::string(DefaultCommandlets[i][0]) + "." + DefaultCommandlets[i][1] + "Commandlet";
| |
| | |
| break;
| |
| }
| |
| }
| |
| | |
| if(Token == "MAKE" || Token == "MAKECOMMANDLET" || Token == "EDITOR.MAKE" || Token == "EDITOR.MAKECOMMANDLET")
| |
| LoadFlags |= LOAD_DisallowFiles; //Not sure what this does but the original ucc has it as well...
| |
| | |
| UClass* Class = UObject::StaticLoadClass(UCommandlet::StaticClass(), NULL, ClassName.c_str(), NULL, LoadFlags, NULL);
| |
| | |
| if(!Class) //If class failed to load, appending "Commandlet" and trying again
| |
| Class = UObject::StaticLoadClass(UCommandlet::StaticClass(), NULL, (ClassName + "Commandlet").c_str(), NULL, LoadFlags, NULL);
| |
| | |
| if(Class){
| |
| UCommandlet* Commandlet = ConstructObject<UCommandlet>(Class);
| |
| | |
| InWarn->Logf("Executing %s\n", Class->GetFullName());
| |
| | |
| Commandlet->InitExecution();
| |
| Commandlet->ParseParms(InCmdLine);
| |
| | |
| GLog = InWarn; //Redirecting commandlet output to console
| |
| | |
| if(Token == "SERVER" || Token == "SERVERCOMMANDLET" || Token == "ENGINE.SERVER" || Token == "ENGINE.SERVERCOMMANDLET"){
| |
| GIsClient = GIsEditor = 0;
| |
| UServerCommandletMain(); //The ServerCommandlet has a special Main function
| |
| }else if(!Commandlet->FindFunction(NAME_Main)) //If no main function is found, the commandlet is written in native code
| |
| Commandlet->Main(InCmdLine);
| |
| else
| |
| Commandlet->Main(FString(InCmdLine)); //For non-native commandlets this overload has to be used
| |
| | |
| GLog = GFileLog;
| |
| }else{
| |
| InWarn->Logf("Commandlet %s not found", __argv[1]);
| |
| }
| |
| }else{
| |
| InWarn->Log("Usage:");
| |
| InWarn->Log(" ucc CommandletName <parameters>");
| |
| }
| |
| | |
| appPreExit();
| |
| GIsGuarded = 0;
| |
| }catch(...){
| |
| ExitVal = EXIT_FAILURE;
| |
| GIsGuarded = 0;
| |
| InError->HandleError();
| |
| }
| |
| | |
| appExit();
| |
| std::exit(ExitVal); //Needed in order to prevent this function from returning to SWRepublicCommando.exe
| |
| }
| |
| </source>
| |
