Skip to content

pwolfe/OpenJK

 
 

Repository files navigation

JACoders "OpenJK" project

IRC: irc.arloria.net / #JACoders (webchat)

The purpose of this project is to maintain and improve the Jedi Academy and Jedi Outcast games, developed by Raven Software. This project will not attempt to rebalance or otherwise modify core gameplay aspects.

Major enhancement changes are very low priority at this time unless patches are made available and do not alter the core functionality of gameplay or the stock renderer itself.

Please use discrection when making issue requests here on github. The JKHub sub-forum is a better place for larger discussions on changes that aren't actually bugs.

64-bit Support (lack there-of)

Currently, 64-bit is not supported at this time due to the amount of code that is not compatible or would cause direct issues. If you would like to submit a patch via pull request to correct it fully, feel free to do so as it would be appreciated.

Installation

First, install Jedi Academy. If you don't already own the game you can buy it from either Steam, Amazon or Play.

Then point the OpenJK installer to the GameData folder in the Jedi Academy install, e.g. just point it to your "Jedi Academy/GameData" folder. If you've downloaded an archive, just unpack it to GameData.

Maintainers (in alphabetical order)

  • eezstreet
  • Ensiform
  • mrwonko
  • Raz0r
  • redsaurus
  • Xycaleth

Significant contributors (in alphabetical order)

  • exidl
  • Scooper
  • Sil

Dependencies

  • OpenGL
  • OpenAL (included on Windows)
  • libpng (optional)
  • libjpeg (optional)
  • zlib (included on Windows)

Dedicated Server

In order to run dedicated server, you must use the openjkded binary, running dedicated from the main executable is currently not allowed because it is broken with the addition of modular renderer.

Developer Notes

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

Please be aware of the implications of the GPLv2 licence. In short, be prepared to share your code.

If you wish to contribute to OpenJK, please do the following

  • Fork the project on Github
  • Create a new branch and make your changes
  • Send a pull request to upstream (Razish/OpenJK)

If you wish to base your work off OpenJK (mod or engine)

  • Fork the project on Github
  • Change the GAMEVERSION define in codemp/game/g_local.h from "basejka_modbase" to your project name
  • If you make a nice change, please consider backporting to upstream via pull request as described above. This is so everyone benefits without having to reinvent the wheel for every project.

Reserved renderer names

  • rd-vanilla (JA's original renderer)
  • rd-dedicated (Stripped down renderer for use with dedicated server)
  • rd-raspberry (OpenGL ES compliant renderer for use with Raspberry Pi - feel free to maintain!)
  • rd-strawberry (Maintainer: Xycaleth)
  • rd-vader (Maintainer: mrwonko)

Sorry for the history changes!

For legal reasons we had to make changes to the history. This likely broke every forker's repo. See here for how to fix if you've changed anything, or just delete your github fork and local folder and start over if you haven't.

Engine "hax"

  • You will no longer be able to use runtime memory patches. Consider forking OpenJK and adding your engine modifications directly.

Links of Interest

About

Community effort to maintain and improve Jedi Academy + Jedi Outcast released by Raven Software

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 63.7%
  • C 33.2%
  • Objective-C 3.1%