idTech4A++ (Harmattan Edition)

idTech engine games For Android. An idTech games runtime libraries collection on Android

DOOM III/Quake 4/Prey(2006) OpenGLES on Android/Windows/Linux

DOOM 3 BFG/The Dark Mod/Quake 1 2 3/RTCW/GZDOOM/ETW/RealRTCW OpenGLES on Android

毁灭战士3/雷神之锤4/掠食(2006) 安卓/Windows/Linux OpenGLES移植版

毁灭战士3 BFG/The Dark Mod/雷神之锤1 2 3/重返德军总部/GZDOOM/深入敌后: 德军总部/真·重返德军总部 安卓OpenGLES移植版

Original named DIII4A++, based on com.n0n3m4.diii4a's OpenGLES version.

Latest version: 1.1.0harmattan59(natasha)
Latest update: 2024-11-20
Arch: arm64 armv7-a
Platform: Android 4.4+
License: GPLv3

idTech4's feature

• Linux/Windows(MinGW/MSVC(without editor)) build
• multi-threading renderer
• png/dds texture image, jpeg/png/bmp/dds format of screenshot
• obj/dae format static model
• pure soft shadow with shadow-mapping
• soft shadow with stencil-shadow and translucent stencil shadow
• lighting model: Phong/Blinn-phong/PBR/Ambient(no-lighting)
• debug render tools support with programming render pipeline
• OpenGLES2.0/OpenGLES3.0
• OpenAL(soft) and EFX Reverb
• DOOM3(with full body awareness mod)
• Quake4(with bot mod, full body awareness mod) and Raven's idTech4 engine
• Prey(2006)(with full body awareness mod) and HumanHead's idTech4 engine

Build DOOM3/Quake4/Prey(2006) mod for Android idTech4A++

DOOM 3 & RoE SDK
Quake 4 SDK
Prey(2006) SDK

Compare with other OpenGLES rendering version of DOOM3

Support games

<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">

Or download the latest APK from the Releases Section. Tag with -free only for F-Droid update.

Testing version(Non-release. Automatic CI building By Github actions when pushing commits)

• idTech4A++ for Android: Android testing.
• DOOM 3/Quake 4/Prey(2006) for Windows x64: Windows x64 testing.

Update

• Support Omni-Bot in Wolfenstein: Enemy Territory.
• Fix rendering on Mali GPU in DOOM 3-BFG.
• Fix rendering on Mali GPU in The Dark Mod.
• Fix stencil shadow with cg_shadows = 2 in Wolfenstein: Enemy Territory.
• Support choose a mod directory in GZDOOM.
• Add some new features options on launcher in Wolfenstein: Enemy Territory, RealRTCW, DOOM3-BFG, Quake 2, GZDOOM, The Dark Mod.
• Add use high precision float on GLSL shaders(cvar harm_r_useHighPrecision) in DOOM 3/Quake 4/Prey.
• Add 5 onscreen buttons.
• Add Phobos(for Dhewm3) mod of DOOM3 support, game data directory named tfphobos(d3xp and dhewm3 compatibility patch required). More view in Doom 3: Phobos and Doom 3: Phobos - dhewm3 compatibility patch.

• 深入敌后:德军总部新增Omni-Bot支持.
• 毁灭战士3-BFG修复在Mali GPU上的渲染问题.
• The Dark Mod修复在Mali GPU上的渲染问题.
• 修复深入敌后:德军总部的模板阴影当cg_shadows = 2.
• GZDOOM选择mod时支持选择整个文件夹.
• 启动器新增一些新特性的设置功能: 深入敌后:德军总部, 真·重返德军总部, 毁灭战士3-BFG, 雷神之锤2, GZDOOM, The Dark Mod.
• 毁灭战士3/雷神之锤 4/掠食(2006)支持GLSL着色器中使用高精度浮点数(cvar harm_r_useHighPrecision).
• 新增5个虚拟按键.

Standalone game directory

Because more support games, it cause all game mods data directory put on a shared folder, them maybe have same name, and diffcult to view/manage. So application default enable Standalone game directory since version 1.1.0harmattan57, and you can also disable it on launcher settings.

If enable Standalone game directory, game data directory should put on Standalone game directory itself(e.g.).

Games of Standalone game directory and folder name:

• DOOM III: doom3/
• Quake 4: quake4/
• Prey(2006): prey/
• Quake I: quake1/
• Quake II: quake2/
• Quake III: quake3/
• Return to Castle Wolfenstein: rtcw/
• DOOM 3 BFG: doom3bfg/
• Wolfenstein - Enemy Territory: etw/
• RealRTCW: realrtcw/

Games of always force Standalone game directory:

• The Dark Mod: darkmod/
• GZDOOM: gzdoom/

idTech4's new Cvar

Flag

• ARCHIVE = save to/load from config file
• FIXED = can't change in game
• READONLY = readonly, always can't change
• INIT = only setup on boot command
• ISSUE = maybe has bugs
• DEBUG = only for developer debug and test
• DISABLE = only for disable something and keep original source code

idTech4's new command

About Prey(2006)

For playing Prey(2006)(jmarshall 's PreyDoom). Now can play all levels, but some levels has bugs.

1. Putting PC Prey game data file to preybase folder and START directly.
2. Some problems solution: e.g. using cvar harm_ui_translateAlienFont to translate Alien text on GUI.
3. Exists bugs: e.g. some incorrect collision(using noclip), some GUIs not work(Music CD in RoadHouse).
4. If settings UI is not work, can edit preyconfig.cfg for binding extras key.

   • bind "Your key of spirit walk" "_impulse54"
   • bind "Your key of second mode attack of weapons" "_attackAlt"
   • bind "Your key of toggle lighter" "_impulse16"
   • bind "Your key of drop" "_impulse25"

About Quake IV

For playing Quake 4(jmarshall 's Quake4Doom). Now can play all levels, but some levels has bugs.

1. Putting PC Quake 4 game data file to q4base folder and START directly.
2. Suggest to extract Quake 4 patch resource to q4base game data folder first(in menu Other -> Extract resource).
   • SABot a9 mod multiplayer-game map aas files and bot scripts(for bots in multiplayer-game).

Problems and resolutions

1. Particle system: Now is not work(Quake4 using new advanced BSE particle system, it not open-source, jmarshall has realized and added by decompiling ETQW's BSE binary file, also see jmarshall23/Quake4BSE), but it not work yet. Now implementing a OpenBSE with DOOM3 original FX/Particle system, some effects can played, but has incorrect render.
2. Entity render: Some game entities render incorrect.

Bot mod

1. Added SABot a7 mod support.
2. Extract q4base/sabot_a9.pk4 file in apk to Quake4 game data folder, it includes some defs, scripts and MP game map AAS file.
3. Set cvar harm_g_autoGenAASFileInMPGame to 1 for generating a bad AAS file when loading map in Multiplayer-Game and not valid AAS file in current map, you can also put your MP map's AAS file to maps/mp folder(botaas32).
4. Set harm_si_autoFillBots to 1 for automatic fill bots when start MP game.
5. Execute addbots for add multiplayer bot.
6. Execute fillbots for auto fill multiplayer bots.

Screenshot

Game

Mod

Other

Changes:

Change logs

Build:

• idTech4A++ using std libc's malloc/free in Mem_Alloc/Mem_Free in idlib/Heap.cpp
• idTech4A++ force using generic SIMD, not compile all SIMD of processor in all platform(TODO: enable them on windows/Linux)

Engine

1. _MULTITHREAD: Add multithread support for rendering.
2. _USING_STB: Using stb header for jpeg/png/dds texture image and jpeg/png/bmp/dds screenshot support.
3. _K_CLANG: If compiling by clang not GCC.
4. _MODEL_OBJ: Add obj static model support.
5. _MODEL_DAE: Add dae static model support.
6. _SHADOW_MAPPING: Add Shadow mapping support.
7. _OPENGLES3: Add OpenGLES3.0 support.
8. _OPENAL _OPENAL_EFX _OPENAL_SOFT: Add OpenAL(soft) and EFX Reverb support.
9. _NO_LIGHT: Add no lighting support.
10. _STENCIL_SHADOW_IMPROVE: Add stencil shadow improve support(translucent shadow, force combine global shadow and self local shadow).
11. _SOFT_STENCIL_SHADOW: soft shadow(OpenGLES3.1+), must defined _STENCIL_SHADOW_IMPROVE first.
12. _MINIZ: Using miniz instead of zlib, using minizip instead of DOOM3's UnZip(Disabled).
13. _USING_STB_OGG: Using stb_vorbis instead of libogg and libvorbis(Disabled).

If want to port Quake4 or Prey(2006) to PC or other platform of based on DOOM3 engine open-source version, because DIII4A based on Android platform and OpenGLES, so has some differences with original version. But I mark some macros in source as patches at all changes, although must find these macros in source code and manual use these patches.

And for keeping original DOOM3 source file structures, for all new source files, I put them on a new folder, and in these folder has same directory structure with DOOM3(e.g. framework, renderer, idlib...).

Quake 4

_RAVEN, _QUAKE4 is patches macros, find them in DIII4A source code.

All new sources files put on raven folder.

1. _RAVEN: for compile core engine (DOOM3 source code) and idlib (DOOM3 source code).
2. _QUAKE4: for compile game (Q4SDK source code) library.
3. Build core engine: define macro _RAVEN, _RAVEN_FX(OpenBSE if need, unnecessary)
4. Build game library: define macro _RAVEN, _QUAKE4

   About BSE

   Because BSE not open-source, so I default supply a NULL implement and a uncompleted but working implement with DOOM3 Particle/Fx system(using macros _RAVEN_FX marked).

   About BOT

   Define macro MOD_BOTS will compile SABot a7(from DOOM3) mod source code for bot support in multiplayer-game.

   About Full body awareness support

   Define macro _MOD_FULL_BODY_AWARENESS will compile Full-body-awareness support. Define macro _MOD_VIEW_BODY will compile view-body support.

Prey(2006)

_HUMANHEAD, _PREY is patches macros, find them in DIII4A source code.

All new sources files put on humanhead folder.

1. _HUMANHEAD: for compile core engine (DOOM3 source code) and idlib (DOOM3 source code).
2. _PREY: for compile game (PreySDK source code) library.
3. Build core engine: define macro _HUMANHEAD
4. Build game library: define macro _HUMANHEAD, _PREY, and original SDK macros HUMANHEAD

   About Full body awareness support

   Define macro _MOD_FULL_BODY_AWARENESS will compile Full-body-awareness support.

Android

Define macro __ANDROID__.

1. _OPENSLES: Add OpenSLES support for sound.

Linux

1. REQUIRE ALSA, zlib, X11, EGL
2. ./cmake_linux_build_doom3_quak4_prey.sh

Windows(MSVC)

1. REQUIRE SDL2, cURL, zlib: vcpkg install SDL2 curl
2. Setup your vcpkg.cmake path
3. cmake_msvc_build_doom3_quak4_prey.bat
4. Copy OpenAL32.dll from vcpkg package path to binary path: vcpkg install OpenAL-Soft

Player body view in DOOM3/Quake4

1. Declaration player_viewbody

   
   entityDef player_viewbody { // default name is player_viewbody, or setup in player entity with property 'player_viewbody'
   "spawnclass"                "idViewBody"
   "body_model"                "player_model_torso_and_lower_body" // body's md5 model: animations's name same as player model: string
   "body_offset"               "-15 0 0" // extras model offset: vector <forward right up>, default = 0 0 0
   "body_allChannel"           "0" // play animation with all channels, else only play with legs channel: bool, default = 1
   "body_usePlayerModel"       "0" // use player model and not use 'body_model': bool, default = 0
   // "anim run_forward"       "walk_forward" // override model animation name: string, "anim <model animation name>" "<replace animation name>"

// Hide surface only for Quake4
"body_hidesurfaces"         "shader_head,shader_toast" // hide surface names, separate by ',': string
"hidesurface1"          "shader_arm" // hide surface name by entity property: string, hidesurfaceXXX
"hidesurface5"          "shader_neck"
"hidesurface6"          "shader_hand"

}

> 2. DOOM3's player view body model declaration(animations name same as idPlayer's model)

// DOOM3 view body model example: model player_model_torso_and_lower_body { offset (0 0 0) model models/md5/player_model_torso_and_lower_body.md5mesh

// loop anims: idle models/md5/player_model_torso_and_lower_body/idle.md5anim run_forward models/md5/player_model_torso_and_lower_body/run_forward.md5anim run_backwards models/md5/player_model_torso_and_lower_body/run_backwards.md5anim run_strafe_left models/md5/player_model_torso_and_lower_body/run_strafe_left.md5anim run_strafe_right models/md5/player_model_torso_and_lower_body/run_strafe_right.md5anim walk models/md5/player_model_torso_and_lower_body/walk.md5anim walk_backwards models/md5/player_model_torso_and_lower_body/walk_backwards.md5anim walk_strafe_left models/md5/player_model_torso_and_lower_body/walk_strafe_left.md5anim walk_strafe_right models/md5/player_model_torso_and_lower_body/walk_strafe_right.md5anim crouch models/md5/player_model_torso_and_lower_body/crouch.md5anim crouch_walk models/md5/player_model_torso_and_lower_body/crouch_walk.md5anim crouch_walk_backwards models/md5/player_model_torso_and_lower_body/crouch_walk_backwards.md5anim fall models/md5/player_model_torso_and_lower_body/fall.md5anim

// single anims: crouch_down models/md5/player_model_torso_and_lower_body/crouch_down.md5anim crouch_up models/md5/player_model_torso_and_lower_body/crouch_up.md5anim run_jump models/md5/player_model_torso_and_lower_body/run_jump.md5anim jump models/md5/player_model_torso_and_lower_body/jump.md5anim hard_land models/md5/player_model_torso_and_lower_body/hard_land.md5anim soft_land models/md5/player_model_torso_and_lower_body/soft_land.md5anim }

> 3. Quake4's player view body model declaration(animations name same as idPlayer's model)

// Quake4 view body model example: model player_model_torso_and_lower_body { offset (0 0 0) model models/md5/player_model_torso_and_lower_body.md5mesh

// loop anims: idle models/md5/player_model_torso_and_lower_body/idle.md5anim run_forward models/md5/player_model_torso_and_lower_body/run_forward.md5anim run_backwards models/md5/player_model_torso_and_lower_body/run_backwards.md5anim run_strafe_left models/md5/player_model_torso_and_lower_body/run_strafe_left.md5anim run_strafe_right models/md5/player_model_torso_and_lower_body/run_strafe_right.md5anim walk_forward models/md5/player_model_torso_and_lower_body/walk_forward.md5anim walk_backwards models/md5/player_model_torso_and_lower_body/walk_backwards.md5anim walk_left models/md5/player_model_torso_and_lower_body/walk_left.md5anim walk_right models/md5/player_model_torso_and_lower_body/walk_right.md5anim crouch models/md5/player_model_torso_and_lower_body/crouch.md5anim crouch_walk models/md5/player_model_torso_and_lower_body/crouch_walk.md5anim crouch_walk_backward models/md5/player_model_torso_and_lower_body/crouch_walk_backward.md5anim fall models/md5/player_model_torso_and_lower_body/fall.md5anim

// single anims: crouch_down models/md5/player_model_torso_and_lower_body/crouch_down.md5anim crouch_up models/md5/player_model_torso_and_lower_body/crouch_up.md5anim run_jump models/md5/player_model_torso_and_lower_body/run_jump.md5anim jump models/md5/player_model_torso_and_lower_body/jump.md5anim hard_land models/md5/player_model_torso_and_lower_body/hard_land.md5anim soft_land models/md5/player_model_torso_and_lower_body/soft_land.md5anim }

----------------------------------------------------------------------------------

### About:

* Source in `assets/source` folder in APK file.
* Using `exportGLSLShaderSource` command can export GLSL shaders.

----------------------------------------------------------------------------------

### Branch:

> `master`:
> * /idTech4Amm: frontend source
> * /Q3E /Q3E/src/main/jni/doom3: game source
> * /CHECK_FOR_UPDATE.json: Check for update config JSON

> `free`:
> * For F-Droid pure free version.

> `package`:
> * /screenshot: screenshot pictures
> * /source: Reference source
> * /pak: Game resource

> `n0n3m4_original_old_version`:
> * Original old `n0n3m4` version source.

----------------------------------------------------------------------------------
### Extras download:

* [Baidu网盘: https://pan.baidu.com/s/1hXvKmrajAACfcCj9_ThZ_w](https://pan.baidu.com/s/1hXvKmrajAACfcCj9_ThZ_w) 提取码: `pyyj`
* [Baidu贴吧: BEYONDK2000](https://tieba.baidu.com/p/6825594793)
* [F-Droid(different signature)](https://f-droid.org/packages/com.karin.idTech4Amm/)
----------------------------------------------------------------------------------

### Open source licence
> Game engine
* DOOM 3: GPLv3
* Quake4 SDK
* Prey SDK
* RBDOOM-3-BFG
* TheDarkMod
* ioq3
* iortcw
* yQuake2
* Darkplaces
* GZDOOM
* ETLegacy
* RealRTCW
> Library(Source)
* cJSON 
* curl: The curl license
* etc2comp
* flac: GNU Free Documentation License / GNU GENERAL PUBLIC LICENSE Version 2 / GNU LESSER GENERAL PUBLIC LICENSE Version 2.1 / BSD-3-Clause license
* fluidsynth
* freetype: The FreeType License / The GNU General Public License version 2
* iconv
* irrxml
* libjpeg
* libogg
* libpng
* libsndfile
* libvorbis
* lua
* mbedtls
* miniz
* minizip
* mp3lame
* mpg123
* oboe
* Omni-Bot
* openal-soft
* openssl
* opus
* pugixml
* soil
* sqlite
* stb
> Library(Binary)
* ffmpeg-mobile
----------------------------------------------------------------------------------