OpenJK: Difference between revisions

From Jedi Knight Wiki | JKHub
mNo edit summary
mNo edit summary
 
Line 2: Line 2:
|logo=Openjk.jpg
|logo=Openjk.jpg
|name=OpenJK
|name=OpenJK
|game=[[Jedi Academy]]
|game=''[[Jedi Knight: Jedi Academy]]''
|type=[[Client-side]], [[Server-side]]
|type=[[Client-side]], [[Server-side]]
|creator=[[JA_Coders]]
|creator=[[JA_Coders]]
|website=openjk.org
|website=openjk.org
}}
}}
'''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.
'''OpenJK''' is an effort by the [[JA_Coders|JACoders]] group to maintain and improve the game engines on which the ''[[Jedi Knight: Jedi Academy]]'' and ''[[Jedi Knight II: 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:
The goals of OpenJK are to:
<pre>Improve the stability of the engine by fixing bugs and improving performance.
*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.
*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>
*Make available this engine to more operating systems. To date, we have releases on Windows, Linux and macOS.


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].
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].
Line 24: Line 24:
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.
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.


[https://www.youtube.com/watch?v=5iJhirSiQGA Video instructions for installing OpenJK for Jedi Academy]
[https://www.youtube.com/watch?v=5iJhirSiQGA Video instructions for installing OpenJK for ''Jedi Academy'']
=== Windows ===
=== Windows ===


Line 30: Line 30:
Download OpenJK for Windows [https://jkhub.org/files/file/3856-openjk-for-jedi-academy/ here].
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.
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 <code>C:/Program Files/Steam/steamapps/common/Jedi Academy/GameData</code>.
      
      
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.
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.
Run <code>openjk.x86.exe</code>.


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

Latest revision as of 14:37, 16 February 2023

OpenJK
Game Jedi Knight: Jedi Academy
Type Client-side, Server-side
Creator JA_Coders
Website openjk.org

OpenJK is an effort by the JACoders group to maintain and improve the game engines on which the Jedi Knight: Jedi Academy and Jedi Knight II: 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:

  • 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.

The OpenJK JKHub sub-forum is the best place for support queries, discussions, and feature requests. Bug reports and major issues should be reported as Issues on GitHub.

Download OpenJK on JKHub

License[edit]

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

Installation[edit]

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.

Video instructions for installing OpenJK for Jedi Academy

Windows[edit]

Download OpenJK for Windows 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 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[edit]

If you do not have a windows partition and need to download the game base.

Download and Install 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[edit]

Follow this tutorial. Support for Intel & Apple Silicon (M1, M2 chips) via Universal 2.

For Developers[edit]

OpenJK on GitHub

Building OpenJK[edit]

Contributing to OpenJK[edit]

Using OpenJK as a base for a new mod[edit]

  • 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[edit]

Many coders have contributed to the success and progress of the OpenJK project. Here are some notables.

Maintainers[edit]

  • Ensiform
  • Razish
  • Xycaleth

Significant contributors[edit]

  • eezstreet
  • exidl
  • ImperatorPrime
  • mrwonko
  • redsaurus
  • Scooper
  • Sil
  • smcv