Skip to content

/gorc

Early-development Jedi Knight: Dark Forces 2 game engine recreation
game-remake game-engine c-plus-plus
  1. C++ 97.5%
  2. CMake 2.0%
  3. Other 0.5%
Branch: develop
Find File
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@jdmclark
jdmclark Hacked together some texture override code for testing 
Modified the material utility to accept an optional colormap. If
specified, the colormap is used for dumping the material cels and mipmap
levels to disk. Previously, material could only output an indexed
bitmap.

Modified the material loader to look for an override png on disk.

This is a relatively quick and dirty hack I used to test Gorc with some
upsampled textures. Texture override is an obviously desirable feature,
so I am pushing these changes for future use.
Latest commit 1889b4d Feb 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmake/modules Replaced the build system with CMake Dec 9, 2018
game Added dflt.cog Mar 30, 2016
rules Replaced the build system with CMake Dec 9, 2018
scripts Started migrating testsuite over to boc-shell Dec 20, 2015
src Hacked together some texture override code for testing Feb 28, 2019
tests/jk Added initial material deserialization Feb 20, 2016
.clang-format More maintenance changes Dec 9, 2018
.clang-tidy More maintenance changes Dec 9, 2018
.gitignore Hacked together some texture override code for testing Feb 28, 2019
.travis.yml Replaced the build system with CMake Dec 9, 2018
CMakeLists.txt Added span utility Dec 10, 2018
LICENSE Initialized branch with license and readme Aug 29, 2015
README.md Replaced the build system with CMake Dec 9, 2018
activate.sh Updated doc, removed unused Makefiles Jan 10, 2016
project.json Replaced the build system with CMake Dec 9, 2018

README.md

Gorc

Build Status Coverage Status Coverity Scan Build Status

Gorc is an early-development Dark Forces II game engine recreation. The goal of the Gorc project is to replace the original game executable, allowing the original singleplayer and multiplayer levels to be played on new platforms.

Developing

Dependencies

  • Standard C++14 compiler (GCC 7)
  • CMake 3.8 or better
  • SFML 2.1
  • Boost
  • Gcovr 3.2
  • Dark Forces II

Quick Start

Building

  • Build the entire project from the project root:
cmake -DCMAKE_BUILD_TYPE=Release .
make -j4

Testing

The test harness is an executable named boc. It was built as part of the previous step, and is located in the pkg/bin directory.

  • Run all tests: run boc test from the project root.

or

  • Run a subset of tests: run boc test from a component source directory.

or

  • Run a specific test: run boc from the test directory.

Test Coverage

Gorc uses the gcov coverage tool. The Gorc build system provides special options for coverage report generation. Use the following command to quickly generate a complete coverage report with an instrumented build.

  • Run boc test coverage-report from the project root.

The Gorc project has adopted a 100% line coverage policy to encourage the development of highly testable code. The test coverage report must show 100% line coverage before any code changes will be accepted.

Running

One-Time Setup

Before running Gorc, you must copy your Dark Forces II original episode and resource directories into the game directory in the root of this repository. Gorc will not work without these directories. This step only needs to be done once.

Run Client

Gorc does not currently allow you to play through the levels normally. You must manually specify an episode GOB and a level filename on the command line.

For example, to play the first level you would run:

pkg/bin/client --episode game/episode/jk1.gob --level 01narshadda.jkl

Other episodes and levels can be played by using appropriate --episode and --level options.

If you do not know the level filenames inside an episode, you can use the included gob utility to list them:

pkg/bin/gob --file game/episode/jk1.gob --extract episode.jk
You can’t perform that action at this time.