Customized Quake2 engine with Heretic2 code parts.

Heretic 2 SDK code based on Ht2Toolkit

Updated code based on Heretic 2 Reconstruction Project

Tested with Heretic 2 Loki release.

cleanup code

sed -i 's/[[:blank:]]*$//' */*.{c,h}

Comments:

It's on really initial steps, it could be complied ;-), it runs mostly without crashes. That's all what is good.

Drawbacks, sorted by priority:

• remove client->playerinfo.c_mode hack,
• fix acrobatic,
• fix rope,
• fix puzzles,
• fix invisible FXSphereOfAnnihilation spell (bind 8),
• use zalloc instead resource_manager,
• implement menu_help to show level goals,
• keep old mission goals if map is not provided new one, look to trigger_mission_*,
• game memory management, fix or replace singlelinkedlist,
• save code broken as not all callbacks registered
• effects is not started sometime,
• only gl1 has full support render
• need to rewrite RF_TRANS_ADD to use quake2 logic
• unsupported foodstep with unsupported player ground surface,
• third person code is different to quake 2,
• correctly implement misc_remote_camera.
• progress bars has custom implementation,
• color type/paticles/effects,
• get rid C++ code,
• other logic of animations, reuse jabots code or replace to more sync logic,
• huge amount of possibly dead code
• no menu implementations
• no books implementations
• code is little bit mess
• fix attack angle direction,
• no action on button press,
• broken jumps,
• effects protocol is different to quake 2,
• code use different angles values to quake2,
• ANGLE_1 usage in client code,
• different move code and noclip,
• implement books as sprite,
• Incorrect 16 bit frame flag unset,
• MAX_MODELS/MAX_SOUND define hardcode,
• soft,gl3,vk render has incorrect angles (used same angle in all renders).

Minimal file set from Loki release:

7f705e54da770186abd84f1a904faa28 baseq2/default.cfg
75cd6a0e878f24bb934e640b4d4dd18c baseq2/htic2-0.pak
d771f54be69f8fb9054c5a84a2b61dff baseq2/players/male/Corvus.m8
4633cc6801f36898f0d74ab136ce013e baseq2/players/male/tris.fm
b90b7cc08ec002297a320e06bae6a5eb baseq2/video/bumper.mpg
b92d295e769b2c5a94ee2dbf1bbe12e4 baseq2/video/intro.mpg
9c201601fdd82754068d02a5474a4e60 baseq2/video/outro.mpg

Maps checked:

Name	map	Video
Silverspring Docks	ssdocks
Silverspring Warehouses	sswarehouse
The Town of Silverspring	sstown
Silverspring Palace	sspalace

Code checked with:

map ssdocks

Goals:

• Implement minimal set required for single player,
• Multiplayer game or same protocol is not in priority,
• Raven code should be placed only in src/game or separate repository,
• All other code should be GPL or public domain,
• Minimal set of hacks over quake 2 engine.

Yamagi Quake II Remaster

This is an experimental fork of Yamagi Quake II with ongoing work to add support for Quake II Enhanced aka Q2 Remaster(ed). This enhanced version has a lot non trivial changes, adding support isn't easy and takes time. Feel free to try this code but you mileage may vary.

Have a look at the yquake2 repository for the "normal" Yamagi Quake II: https://github.com/yquake2/yquake2

• Alpha windows 64 bit binaries.
• Saves format is unstable and could change between alpha releases.
• MacOS build is only build tested and run is not checked.
• As benchmark could be used phoronix-test-suite profile.

Building from Source

If you downloaded the Source Code (ZIP) directly from GitHub, please note that GitHub does not include submodules in these archives. To build the project successfully, you have two options:

• Follow the step-by-step instructions for a lightweight setup
• Use CMake without submodules.

Asset Support

Yamagi Quake II Remaster supports a wide variety of model, texture, sprite, map, sound, and package formats from classic id Tech games and related titles (such as Quake, Quake 2, Half-Life, Hexen 2, Daikatana, SiN, Anachronox, Heretic 2, and Quake 3).

For complete technical specifications and compatibility tables, see .agents/docs/asset_support.md.

Games:

• Quake 2 ReRelease:
  • SDK: https://github.com/id-Software/quake2-rerelease-dll
  • Tech info: https://bethesda.net/en/article/6NIyBxapXOurTKtF4aPiF4/enhancing-quake-ii
  • PSX source: https://www.moddb.com/mods/quake-ii-psx/downloads/quake-ii-psx-10-sources
  • PSX Mod: https://www.moddb.com/mods/quake-ii-psx
• Anachronox:
  • SDK: https://github.com/hogsy/chronon
  • SDK: https://code.idtech.space/ion-storm/anachronox-sdk
  • Tech info: https://anachrodox.talonbrave.info/
• Kingpin:
  • SDK: https://github.com/QuakeTools/Kingpin-SDK-v1.21
  • SDK: https://code.idtech.space/xatrix/kingpin-sdk
  • Tech info: https://www.kingpin.info/
• Daikatana:
  • Info: http://daikatananews.net/
• Heretic 2:
  • SDK: https://www.quaddicted.com/files/idgames2/planetquake/hereticii/files/Ht2Toolkit_v1.06.exe
  • SDK: https://code.idtech.space/raven/heretic2-sdk
  • Tech info: http://h2vault.infinityfreeapp.com/index.html
• SiN:
  • Tools: SiNview
  • Tools: https://www.moddb.com/games/sin/downloads/sin-modding-tools-and-other-stuff
  • SDK: https://github.com/NightDive-Studio/sin-ex-game
  • SDK: https://github.com/jimdose/SiN_110_Source
  • SDK: https://code.idtech.space/ritual/sin-sdk
• Dawn of Darkness:
  • Docs: https://www.moddb.com/mods/dawn-of-darkness1/downloads/dod-mood-scripts-gsm-tutorials-fgd-and-def-file
  • Demo: Episode 1
• Infinity: The Kai'Ren Threat
  • Demo: Demo maps
• Oblivion:
  • SDK: https://github.com/themuffinator/REBLIVION/
  • Demo: https://www.celephais.net/oblivion/main.html
• JaBot:
  • SDK: https://www.moddb.com/mods/jabotq2/downloads/jabot-q2-v09x-win32-and-linux
• Additional maps used for check maps support:
  • PSX: https://www.moddb.com/mods/quake-ii-psx/downloads/quake-ii-psx-10
  • ReRelease N64 Jam: https://www.moddb.com/games/quake-2/addons/quake-2-re-release-n64-sp-map-jam
  • ReRelease Basic Jam: https://www.moddb.com/games/quake-2/addons/quake-2-re-release-back-to-baseq2ics-jam-1
  • ReRelease PSX Jam: https://www.moddb.com/mods/psx-jam-1/downloads/quake-2-re-release-psx-jam-1
  • ReRelease Warehouse Jam: https://www.moddb.com/mods/quake-2-re-release-warehouse-jam-1

Games check videos:

• 8.71RR15+:

• 8.61RR15+:

• 8.61RR14+:

• 8.61RR13+:

Checked with:

• Q2Test

• Q2Demo

• Q2 Release

• 8.61RR13:

• 8.52RR13+:

• 8.52RR12+:

• 8.52RR12:

• 8.51RR12:

• 8.42RR12+:

• 8.42RR11:

• 8.42RR10:

• 8.42RR9:

• 8.42RR8:

• 8.31RR7:

Goals, fully finished goals could be checked in here:

• ReRelease maps: shows shadow in the middle of model,
• soft: fix crash with md5 models in player model select and ASAN=1,
• soft: q64/outpost scale textures unsupported,
• soft: broken wall light and wall glitch,
• soft: rework 32bit color cinema workarrounds,
• soft: support scalled textures for models and walls, and fix lighting with remastered maps,
• soft: use separete texture hi-color buffer for ui in soft render,
• vulkan: rearange surfaces before render,
• vulkan: add fog distance effect,
• soft: add fog distance effect (optional),
• reuse memory from models cache in renders model list,
• reuse memory from models cache for bsp,
• game: fix broken base3 with sorted fields names,
• game: code has not reset ctf flag on load saves,
• game: code has reset thirdperson flag on load new level,
• game: check RealBoundingBox with frame box,
• game/client: update bound box based on frame number,
• ReRelease: incorrect dead animation for Arachnid,
• ReRelease: broken fire effect for Guardian.
• ReRelease: water in basicsjam1_ziutek,
• ReRelease: make lightmap textures dynamic n64jam_palmlix,
• ReRelease: support textures/*/*.mat load texture effects,
• ReRelease: support textures/*/*_glow.png load,
• ReRelease: support tactile/*/*.bnvib/.wav feedback load,
• ReRelease: console ~ incorrectly show multibyte characters,
• ReRelease: basicsjam1_detrohogga: fix droptofloor startsolid,
• gl1, gl3, gl4, vk, soft: implement direction of CS_SHADOWLIGHTS,
• gl3, gl4: implement color multiplication and alpha gradient for misc_flare,
• gl3, gl4, vk: fix and port r_bloom,
• gl1, gl3, gl4, vk: apply improvements from gl3 to other renders,
• soft: implement color multiplication and alpha combine or make black parts transparent for misc_flare,
• ReRelease: Add support of func_eye,
• ReRelease: Add support of info_landmark,
• ReRelease: Add support of info_nav_lock,
• ReRelease: Add support of info_world_text,
• ReRelease: Add support of target_healthbar,
• ReRelease: Add support of target_poi,
• ReRelease: Add support of trigger_coop_relay,
• ReRelease: Add support of trigger_health_relay,
• ReRelease: single player support,
• ReRelease: support effects and additional flags when possible,
• ReRelease: implement demo protocol based on https://github.com/res2k/q2proto and https://github.com/Paril/quake2-rerelease-dll,
• ReRelease: modified game code support with removed KEX only related code.

Other games support goals:

• jabot: make count of nodes/edicts dynamic allocations,
• Heretic 2: add swim player animation support,
• Heretic 2: add utf8 colors and fonts support in console,
• Doom: implement map load logic,
• Quake 3: finish map load logic,
• Quake, Half-Life, Hexen 2: fix brush flags,
• Anachronox: load atd as sprite,
• Anachronox: fix incorrect scale of ob_stop-flame and ob_wommhill01,
• Anachronox: skins load broken with mingw win64 build,
• Anachronox: CTC entity format,
• Anachronox: support material load textures/textureinfo.dat,
• Daikatana: Fix protopod animation,
• Daikatana/SiN: Fix transparent textures in maps,
• DoD: fix statusbar roarke,
• Infinity: Add support of item_radar,
• Infinity: Add support of monster_alienship1,
• Infinity: Add support of monster_grunt1v1,
• Infinity: Add support of monster_grunt1v2,
• Infinity: Add support of monster_grunt2,
• Infinity: Add support of monster_screamer,
• Infinity: Add support of weapon_pistol,
• Infinity: Add support of weapon_6bshot,
• Infinity: Add support of weapon_biggun,
• Infinity: Add support of weapon_blaze,
• Infinity: Add support of weapon_goop,
• Infinity: Add support of weapon_rifle,
• Oblivion: Add support of ammo_dod,
• Oblivion: Finish support of func_rotate_train, add speeds for path_corner,
• Oblivion: Add support of misc_camera,
• Oblivion: Add support of misc_camera_target,
• Oblivion: Add support of trigger_misc_camera,
• Oblivion: Add support of weapon_rtdu,
• Oblivion: Add dynamic animation based on activate for badass and floater,
• game: share ired_enforce_limit, mine_enforce_limit, detpack_enforce_limit,
• Dynamic count of entities on client.

Fixed:

Not a goal:

• Multiplayer protocol support with KEX engine,
• Support KEX engine features (inventory, compass and so on),
• KEX game library support.

Additional requirements:

• ReRelease localization requires Q2Game.kpf file in root directory of game. If you like to support your language put it to localization/loc_.txt and extend MAX_FONTCODE to your max symbol code. Used font and language file are defined by language and r_ttffont, as an example could be used fonts like unifont.
• Heretic 2 localization requires levelmsg.txt in game directory.
• Hexen 2 localization requires Strings.txt in game directory.

Yamagi Quake II

Yamagi Quake II is an enhanced client for id Software's Quake II with focus on offline and coop gameplay. Both the gameplay and the graphics are unchanged, but many bugs in the last official release were fixed and some nice to have features like widescreen support, reliable support for high framerates, a modern sound backend based upon OpenAL, support for modern game controllers and a modern OpenGL 3.2 renderer were added. Unlike most other Quake II source ports Yamagi Quake II is fully 64-bit clean. It works perfectly on modern processors and operating systems.

This code is built upon Icculus Quake II, which itself is based on Quake II 3.21. Yamagi Quake II is released under the terms of the GPL version 2. See LICENSE for further information:

• LICENSE

Officially supported operating systems are:

• FreeBSD
• Linux
• Windows

Beside theses Yamagi Quake II has community support for MacOS and most other unixoid operating systems, including NetBSD, OpenBSD and Solaris.

Addons and partner projects

This repository contains Yamagi Quake II itself. The official addons have their own repositories:

• The Reckoning
• Ground Zero
• Three Waves Capture The Flag

Yamagi Quake II Remaster is a project providing optional support for the assets of Quake II Remaster by Nightdive Studios and has a less conservative approach in regards to new features. It also lives in it's own repository:

• Yamagi Quake II Remaster

Development

Yamagi Quake II is a community driven project and lives from community involvement. Please report bugs in our issue tracker:

• Issue Tracker

We are always open to code contributions, no matter if they are small bugfixes or bigger features. However, Yamagi Quake II is a conservative project with big focus on stability and backward compatibility. We don't accept breaking changes. When in doubt please open an issue and ask if a contribution is welcome before putting too much work into it. Open a pull request to submit code:

• Pull Requests

Also have a look at our contributors guide:

• Contributors Guide

Documentation

Yamagi Quake II has rather extensive documentation covering all relevant areas from installation and configuration to package building. Have a look at the documentation index:

• Documentation Index

Releases

Yamagi Quake II releases at an irregular schedule. The official releases with source code tarballs and prebuild Windows binaries can be found at the homepage:

• Homepage

Our CI builds unsupported Linux, MacOS and Windows binaries at every commit. The artifacts can be found here:

• Github Actions