prey-sdk/ReadMe.rtf
2006-10-09 00:00:00 +00:00

36 lines
No EOL
3.8 KiB
Text
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{\rtf1\ansi\ansicpg1252\deff0\deflang1033{\fonttbl{\f0\fswiss\fcharset0 Arial;}}
{\*\generator Msftedit 5.41.15.1507;}\viewkind4\uc1\pard\f0\fs20 Please see \b EULA.Development Kit.rtf\b0 for permissions and legal information.\par
\par
Thanks for downloading the Prey SDK. Included is all of the code necessary for building a gamex86.dll. I have not included Maya binaries or sample assets, because the ones used in the Doom3 SDK can also be used for Prey reference (in fact, our md5mesh/md5anim formats are completely unchanged). The Doom3 SDK can currently be found here:\par
\par
\ul http://www.iddevnet.com/doom3/downloads.php\ulnone\par
\par
Some examples and information on how you can activate your mod in Prey are included in the ./examples folder.\par
\par
As for the actual code, there are a few things to mention. I made some last-minute changes to clean up some warnings (things that came up after separating out the game code), and to get everything building under MSVC++ 2005 Express Edition. Those changes are marked with //HH rww SDK, but those should be the only differences between this code and the pure 1.02 code. The included solution and project files are for .NET 2005. The code base should still compile in .NET 2003, if you really want to re-make the solution and project files under it. It should also adapt to various free compiler distributions with a makefile and a little effort. I've had it compiling with Intel's C++ compiler before as well. Also, you should note that \b the memory log build will require some code modifications to build\b0 , so you will probably want to start off just using Debug or Release (always use Release for builds that you intend to distribute).\par
\par
\b It's important to note that the code base will compile in the \i free\i0 Microsoft Visual C++ 2005 Express Edition\b0 . This means you don't have to buy an expensive copy of .NET 2005 just to get cracking on some Prey mods. You can download MSVC++ 2005 EE right here:\par
\par
\ul http://msdn.microsoft.com/vstudio/express/visualc/download/\ulnone\par
\par
Just follow the instructions there and get the Platform SDK installed and set up as well, and you will be able to load the Prey solution file and compile with no modifications at all. You have to register with Microsoft to use the product for more than 30 days, but registration is also free and done by e-mail.\par
\par
The game code itself has a few "pitfalls". It was thought, initially, that using hhX versions of classes (inheriting from idX) would make merges less complicated, as the game code was still being written alongside id's during a period when Doom3 was also far from finished. While it may have made merging easier (in a way), it didn't turn out so well in the long-run. We now have a lot of arbitrary and bad inheritance, and huge mounds of code that never make it to binary. We could critisize many areas of the code, but, hopefully, you will still be able to find your way around and get started on some awesome new mods. :)\par
\par
Other than that, the code should be relatively easy and straightforward to dive into. Just load up the solution, select a build configuration (you'll probably want Release to test), and compile away. Remember to check out the Doom3 section of idDevNet as well:\par
\par
\ul http://www.iddevnet.com/doom3/\ulnone\par
\par
Many of the same methods and concepts still apply to Prey, so you will no doubt find it to be a useful resource. Additionally, be sure to make use of the Prey Mods & Editing forum over at the 3D Realms forums:\par
\par
\ul http://www.3drealms.com/forums.html\ulnone\par
\par
I will be keeping an eye on them, so if you have any modding questions for me or the other Heads, feel free to direct them there.\par
\par
\par
Good luck,\par
Rich Whitehouse\par
Human Head Studios, Inc.\par
\par
}