Recently I needed to package up an Unreal build for distribution. You can do this from the Unreal Editor v4.6 by selecting File->Package Project. However, I wanted to automatically create packages on a build machine without human intervention. That meant I needed to find a command I could execute in a script. Skipping to the hard won result, here’s the wooly command line I ended up with:
.\Engine\Build\BatchFiles\RunUAT.bat -verbose BuildCookRun -nocompileeditor -nop4 -project=MyProject.uproject -cook -allmaps -CrashReporter -stage -archive -archivedirectory=c:\Package -package -WindowsNoEditor -clientconfig=Shipping -ue4exe=UE4Editor-Cmd.exe -clean -pak -prereqs -targetplatform=Win64 -build -utf8output
Over twenty command line parameters. How did I figure that all out?
First I searched on the web for “Unreal command line package.” That led me to a promising page, so I tried the recommended command line there. However, when I compared my output with the output generated by the in-editor packaging step, not only were most of the files quite different, there were some files that were in one place and not the other. No dice.
Time to think like a software engineer.
Unreal distributes source code for their engine and editor. So I searched the code for the word archivedirectory (one of the parameters mentioned at the link above), which led me to .\Engine\Source\Editor\…\MainFrameActions.cpp. It has a line that starts with
FString CommandLine = ...
I set a breakpoint on that line in Visual Studio, started up the Unreal Editor, attached to the Unreal Editor from Visual Studio (Debug->Attach to Process), and then selected File->Package Project->Win64 in UE. Breakpoint hit! From there it was simple to copy the actual CommandLine value that UE uses to a batch file and tweak path names as needed.
- I repeated this process a few times, tweaking the settings at Packaging Project->Packaging Settings so I could extract the various command line parameters that can be configured in the editor.
- The –project setting must be the fully qualified path name
- For shipping builds, use –clientconfig=Shipping. For development builds, use –clientconfig=Development. I didn’t try creating a Test build, but that would be an interesting experiment, since you can’t package test builds from inside the editor.
- –clean ensure a full build is done, –build builds code, –cook builds content, and –pak puts the content in a single pak file
- The only platform I was targeting was 64-bit Windows, so you’ll need to validate the targetplatform parameter for other platforms
One of my common software interview questions involves the creation of a game board. Part of the problem includes the generation of random numbers. If the candidate is writing in C/C++, the typical code I see looks something like this:
srand(seed); // one time seeding of generator
// later on ...
r = (rand() % 6) + 1; // throw the dice
r = Math.Floor((Math.Random() * 5) + 1); // [1...6] ?
Takeaway: getting random numbers correct is a non-trivial problem. A lot of information available on the Internet about generating random numbers is plan wrong. Beware. Test your generators to ensure that they are both random and uniform. If I was writing C++ code today that needed to throw a d6, it would look like this:
std::mt19937 mt(seed); // generation engine
std::uniform_int_distribution<int> ud(1,6); // distribution engine
// later on ...
r = ud(mt); // [1...6], uniformly distributed
For a hilarious 30 min excursion into the pitfalls of C/C++ rand(), see Stephan’s talk: rand Considered Harmful. You’ll never use rand() again.
My current project has me writing C# scripts in Unity. Cool. I haven’t written C# for more than a decade. Today I was reviewing code, and noticed this line:
foreach (var child in Children)
Nothing too exciting. Readable. Easy to understand. But as I took a second look, I realized I didn’t truly know what var is all about. Is it defining a variable? What’s the type of child? Could var be replaced with ChildType? What’s best practice? Should I be using var?
Var was introduced in C# v3.0 circa 2007. It turns out it’s the equivalent to auto in C++, which I wrote about not long ago. Var allows the compiler to determine the type automatically.
So, var defines a variable. The type of var is the type that the compiler deduces. Var could be replaced with the actual type, but best practice is to use var whenever you can, just like auto. I’ll be using it regularly from now on.
I’ve always been a proponent of ease of development. All things being equal, when I have a choice I will pick the easier language/tool/environment.
But all things are never equal. Developers have to consider development costs and their personal skillsets and platform install base and hundreds of other variables in their decision to build a product on a particular platform using a particular set of tools.
What wins? Install base.
Example #1: Playstation. Writing games for the original PlayStation, PlayStation 2 — and even PlayStation 3 — is incredibly challenging. The hardware is complex. The documentation is abysmal. C/C++ is de rigueur. But the PlayStation line of game consoles has sold hundreds of millions of units, and developers have risen to the challenge of making PS games, because that huge install base represents the chance of making a fortune.
Example #2: iPhone. Creating apps for iOS is no easy task. Objective-C is an obscure language that is only popular due to the runaway success of iPhones and iPods.
That’s why I was surprised at the recent announcement of Swift. Apple has no business need to create better tools or languages. Developers are not blocked creating iOS apps. Yet Apple continues to improve the Xcode development environment and now introduces a new programming language that should appeal to many developers. Fascinating.
iOS install base. Check.
Apple winning the hearts and minds of developers. Check.
At Microsoft, the tools for my daily work included things like C++, PowerShell, and Visual Studio. I also used many internal tools with names like Source Depot and Razzle. And naturally I used the Windows platform.
It’s both a pleasure and challenge to be working with a completely new set of tools as a developer at HBO. Just in the past week alone, I’ve:
- Programmed in Objective-C
- Used the Xcode development environment
- Written bash scripts
- Managed content with git
- Issued pull requests on GitHub
- Configured builds on Jenkins
- Debugged ARM code on iPad
- Browsed with Safari and Chrome
About the only tool that is consistent between my current and previous jobs is Outlook.
It’s strange to be a novice at so many things. It’s like going back to school. My productivity is low (though growing), but my satisfaction at learning new things is immense.
There’s a lesson to be learned here.
I started a new job this week, working at HBO. After nearly 13 years at a software company, it’s invigorating to be at a content company. The challenges are completely different. The acronyms are new. The focus is on user experience.
One of my favorite books is a collection of essays by Joel Spolsky called User Interface Design for Programmers. Although some of the examples are dated, the key concepts are still relevant.
In preparation for some work my team will be doing on UI, I’ve been reading the online version of Joel’s book. I was struck by his axiom of all UI design: A user interface is well-designed when the program behaves exactly how the user thought it would.
It reminded me of my personal pet peeve of UI design — keyboard entry. I avoid the mouse whenever I can, because (like many software engineers) I’m more efficient when my hands stay on the keyboard. Now consider most websites. They’re often designed for the mouse as the primary form of input, even for things that require the keyboard, such as user names or address forms.
When you go to a banking or credit card site, what’s the first thing you do? You enter your user name. Yet how many sites default the keyboard focus to the user name field? The number is far short of 100%.
Takeaway: when you’re designing UI, consider all your users, and behave the way the user expects.
The challenge with Joel’s axiom of UI design is that all your users are different. One good solution that I learned at Microsoft: create a small suite of user profiles and test against those profiles. For example, you might have a profile that describes a student user, a pro user, and a business user.
And if you’re developing a new website, set the initial keyboard focus to the user name field.
Recently I needed to know the maximum number of decimal digits in a 64-bit unsigned integer. I put together this handy table as a reference.
||1.8 x 10^19
||3.4 x 10^38
||1.16 x 10^77
As the exponent doubles, the number of digits tends to double. If you remember than a 32-bit number has at most ten decimal digits, then it’s easy to remember that a 64-bit number has at most twenty decimal digits, and so on.
Here’s another useful trick involving powers of 1024.
||Power of 2
||1 thousand (10^3)
||1 million (10^6)
||1 billion (10^9)
||1.1 x 10^12
||1.1 x 10^15
||1.2 x 10^18
||1.2 x 10^21
||1.2 x 10^24
||1.2 x 10^27
||1.3 x 10^30
Given a number that’s a power of 1024, i.e. 2^(10 x n), where n is positive integer, the maximum number of decimal digits in the equivalent value is (3 x n) + 1. For instance, for 2^20 = 2^(10 x 2) = 1,048,576, the maximum number of decimal digits is 7, because n is 2 and (3 x 2) + 1. This is true for all values of n through 97 (2^970), so this trick will be handy for a few years to come :)
Using this formula, here’s how you would quickly approximate the maximum number of decimal digits required for a 64-bit integer. Round up 64 to the nearest number divisible by 10 (70). Divide by 10 (7). Multiply by three and add 1 (7 x 3 + 1) = 22. Nice!