• View
• Edit
• History
• Print

Un Code X

Using UnCodeX

Setting Up
First you need to download UnCodeX, so pop over to http://wiki.beyondunreal.com/wiki/UnCodeX and download V232. Run the install and open the application.
When starting UnCodeX for the first time, you're going to recieve a popup box about configuration and asking if you want to edit those settings now. Select yes.

This will open the settings screen, as you see there's plenty of options on it, for right now we're only going to be worried about one or two of them.

First thing we need to do is click Source Paths, then click Add, this will bring up a file explorer, scroll down until you find your Brothers In Arms folder. In most cases, this will be located at C:\Program Files\Ubisoft\Gearbox Software\BrothersInArms\EiB

Click OK.
The next step is to configure your package priority, UnCodeX will ask if you want to import the package priority from the default.ini, click Yes

This will take you back to the Settings Screen, this time we need to work on the package priority, so click Package Priority, if you done the above steps correct, then you should see a list of packages, instantly recognizable will be the packages starting with gbx. I'm always going to want the core Unreal Engine to be worked first, so go ahead and mark the check the following packages.

Next we need to setup an output path for the HTML based documentation that UnCodeX can export, so go ahead and click on HTML Output on the right, click on the file explorer button. You'll notice UnCodeX doesn't allow you to create a folder using this option, so go ahead and make a folder, doesn't matter where, you just need to remember the location so you can explore to it. In my case, I made a folder in C: called UnCodeXHTML.

Hi-lite your folder and click OK. You don't need to worry about any other options at this time, so go ahead and click the OK button with the green check. You will now be asked if you want to scan the source paths for packages and analyze the classes, click yes.

This will start UnCodeX running, you will see some scanner warnings while it runs, just let it carry on. Once finished you'll be left with the source code in my case, I also turn on property browser under View, so my screen looks like:

To export the code out to HTML format, click the HTML Output menu item, and click create all files, this will start the export to HTML, in the folder you specified during original configuration. Ignore any cache warnings. Once complete, go to the folder you specified in the setup and look for the index.html file.

Open the index.html in your favourite browser, and off you go...