Editing OpenJK

[[Category:Mods]]

'''OpenJK''' is an effort by the [[JA_Coders|JACoders]] group to maintain and improve the game engines on which the [[Jedi Academy]] and [[Jedi Outcast]] games run on, while maintaining full backwards compatibility with the existing games. This project does not attempt to rebalance or otherwise modify core gameplay.

The goals of OpenJK are to:
<pre>Improve the stability of the engine by fixing bugs and improving performance.
Provide a clean base from which new JO and JA code modifications can be made.
Make available this engine to more operating systems. To date, we have releases on Windows, Linux and macOS.</pre>

The [https://jkhub.org/forums/forum/49-openjk/ OpenJK JKHub sub-forum] is the best place for support queries, discussions, and feature requests. Bug reports and major issues should be reported as [https://github.com/JACoders/OpenJK/issues Issues on GitHub].

[https://jkhub.org/files/file/3856-openjk-for-jedi-academy/ Download OpenJK on JKHub]

== License ==
OpenJK is licensed under GPLv2 as free software. You are free to use, modify and redistribute OpenJK following the terms in LICENSE.txt.

== Installation ==
To install OpenJK, you will first need Jedi Academy installed. If you don't already own the game you can buy it from online stores such as Steam or GOG.

=== Windows ===
[https://youtu.be/CIOhG5Vy01c Video instructions for installing OpenJK on Windows for Jedi Academy, by Futuza]

Download OpenJK for Windows [https://jkhub.org/files/file/3856-openjk-for-jedi-academy/ here].

Extract or copy/paste the contents of the zip file into the Jedi Academy GameData/ folder. For Steam users, by default this will be in C:/Program Files/Steam/steamapps/common/Jedi Academy/GameData.
    
Download and install Visual C++ Redistributable 2015 found [https://www.microsoft.com/en-gb/download/details.aspx?id=48145 here]. You'll need the x86 version, unless it still gives an error, then try the x64 version as well.

Run openjk.x86.exe.

[Optional] Right click exe and go to "Send to" > Desktop (create shortcut) to put a shortcut on your desktop.

=== Linux ===
If you do not have a windows partition and need to download the game base.
 
Download and Install [https://developer.valvesoftware.com/wiki/SteamCMD#Linux SteamCMD]
 
Set the download path using steamCMD, force_install_dir .
 
Using SteamCMD Set the platform to windows to download any windows game on steam. @sSteamCmdForcePlatformType "windows"
 
Using SteamCMD download the game, app_update 6020.
 
Download OpenJK for Linux above.

Extract the contents of the file into the Jedi Academy GameData/ folder. For Steam users, this will be in <Steam Folder>/steamapps/common/Jedi Academy/GameData.

=== macOS ===
Follow [https://jkhub.org/tutorials/errors-problems/playing-jedi-academy-and-outcast-on-mac-r31/ this] tutorial. Support for Intel & Apple Silicon (M1, M2 chips) via Universal 2.

== For Developers ==
[https://github.com/JACoders/OpenJK OpenJK on GitHub]

=== Building OpenJK ===
* [https://github.com/JACoders/OpenJK/wiki/Compilation-guide Compilation guide]
* [https://github.com/JACoders/OpenJK/wiki/Debugging Debugging guide]

=== Contributing to OpenJK ===
* [https://github.com/JACoders/OpenJK/fork Fork the project on GitHub]
* Create a new branch and make your changes
* Send a [https://help.github.com/articles/creating-a-pull-request pull request] to upstream (JACoders/OpenJK)

=== Using OpenJK as a base for a new mod ===
* Fork the project on GitHub
* Change the GAMEVERSION define in codemp/game/g_local.h from "OpenJK" to your project name
* If you make a nice change, please consider back-porting to upstream via pull request as described above. This is so everyone benefits without having to reinvent the wheel for every project.

== Contributors ==
Many coders have contributed to the success and progress of the OpenJK project. Here are some notables.
=== Maintainers === 
* Ensiform
* Razish
* Xycaleth

=== Significant contributors ===
* eezstreet
* exidl
* ImperatorPrime
* mrwonko
* redsaurus
* Scooper
* Sil
* smcv