This is an updated Star Wars Jedi Knight II: Jedi Outcast 1.04 SDK released under the GPLv2 license. Search for JK2 Editing Tools 2.0 if wish to get familiar with original SDK released by Raven in 2003, containing also tools and guides for creating maps, models, effects, scripts and other modifications.
Creating this repository was made possible thanks to Raven releasing JK2 source code in 2013. This branch contains an altered subset of it necessary for creating code mods, with multiple bug-fixes and refactored code. The downside is that it may be difficult to apply patches based on the original SDK 2.0 source code. This branch is recommended for new projects. Check out a vanilla branch of this repository if you're looking for almost unaltered GPL code.
Read Git commit history for a complete list of changes.
You will need GNU Make and GCC or Clang compiler. Type make to build .so files in base/ and .qvm files in base/vm/ You can add -jN option to speed up the build process by running N jobs simultaneously. Type make help to learn about other targets.
Assume your mod is called "mymod" and your main JK2 directory is ~/.jkii In order to test the mod, put .qvm files in ~/.jkii/mymod/vm/ and launch the game with +set fs_game mymod commandline parameter.
To debug your mod use generated .so files. Put them in ~/.jkii/mymod/ and launch the game with +set vm_game 0 +set vm_cgame 0 +set vm_ui 0 commandline parameters. Set them back to 2 when you want to use .qvm version again.
Currently there is no support for building shared libraries on Windows. Old code/buildvms.bat batch file should work for QVMs if you can get lcc and q3asm tools (eg from JK2 Editing Tools 2.0) and put them into bin/ directory.
I'll be glad to include Windows build scripts, project files etc. if you can create and test them.
LCC 4.1 is Copyright (c) 1991-1998 by AT&T, Christopher W. Fraser and David R. Hanson, and available under a non-copyleft license. You can find it in code/tools/lcc/COPYRIGHT. LCC version bundled with this SDK comes from ioquake3 and it has been slightly modified by it's developers.
Remaining parts of JK2 SDK GPL are licensed under GPLv2 as free software. Read LICENSE.txt and README-raven.txt to learn more. According to the license, among other things, you are obliged to distribute full source code of your mod alongsid it, or at least a written offer to ship it (eg a HTTP download link inside a .pk3 file). Moreovery any mod using patches from this repository has to be released under GPLv2.
Q3ASM is Copyright (c) id Software and ioquake3 developers.
- id Software (c) 1999-2000
- Raven Software (c) 2000-2002
- SaberMod team (c) 2015-2016
- Witold fau Piłat <witold.pilat@gmail.com> (c) 2015-2016
Did you know that, compared to JK2 Editing Tools 2.0 license, GPLv2 doesn't prohibit you from:
- Distributing your mod by means other than internet and even charging for it.
- Creating mods which infringe against third party rights, are libelous, defamatory, obscene, false, misleading and otherwise illegal and unlawful.
- Shipping them to countries to which the U.S. has embargoed goods and to people who are prohibited by applicable law from receiving it.
GPL - JOIN THE DARK SIDE