Skip to content

Home

Jump to bottom
Zack Middleton edited this page Mar 16, 2014 · 134 revisions

Spearmint is a fork of ioquake3 with two main goals; 1) provide a flexible engine for creating new games and mods, 2) support features from (and running) various id Tech 3-based games.

Spearmint can be used to play Quake III Arena, Quake III: Team Arena, and Turtle Arena. Progress has been made toward running Return to Castle Wolfenstein (MP) and Wolfenstein: Enemy Territory, still quite a bit left before it's possible though. Spearmint is not compatible with existing mods (the QVM/DLL files) or demos for any game.

Changes are still being made that affect the VM APIs and network compatibility. Eventually they will be finalized.

Discuss

Major Features

  • Four player splitscreen
  • Moved a lot of code from server and client to Game and CGame VMs;
  • Allow games to modify entityState_t and playerState_t without changing the engine.
  • Extended API for Game and CGame/UI, includes some of the features from;
    • RTCW, WolfET, Tremulous, Turtle Arena, and World of Padman
  • Merged UI VM into CGame VM, easier to modify as a whole / more flexible.
  • Additional shader keywords.

Also see Features Overview. See Roadmap and issues list for future plans.

Current Focus

Updated March 15 2014

Side-tracked on RTCW/ET/SoF2/JK2/JA/etc support.

I'll probably get back to these soon.

Documentation

Features

Also see Features Overview.

Tutorials

  • New Game -- Information about changing the engine game, data paths, etc.
  • New Sounds -- Information about sounds new games might want to add.

License

Spearmint is licensed under a modified version of the GNU GPLv3 (or at your option, any later version), the license is also used by Return to Castle Wolfenstein, Wolfenstein: Enemy Territory, and Doom 3.

Credits

  • id Software
  • Gray Matter Interactive
  • Nerve Software
  • Splash Damage
  • Dark Legion Development
  • Padworld Entertainment
  • ioquake3 contributors
  • Thilo Schulz (for ioquake3 Elite Force MP patch)
  • Rudolf Polzer (for code from NetRadiant's q3map2)
  • Open Arena developers (for "!gametype" entity key)
  • Tobias Kuehnhammer (feedback / bug reports / Bot AI fixes)
  • Zack Middleton (spearmint developer)

Engine Feature Support

Game All Needed Features Lacking Areas Status Ported to Spearmint?
Quake III Arena yes none Complete (inherited from ioquake3) mint-arena
Quake III: Team Arena yes none Complete (inherited from ioquake3) mint-arena
OpenArena yes none Complete Not started
Q3Rally (Standalone) yes none Complete Not started
Tremulous yes game, ui Missing system traps for getting news (ui) and sending game stats to master server (game) Not started
Turtle Arena / Extraordinary Beat X yes none Complete TA, EBX
[[Return to Castle Wolfenstien (SP) RTCW-SP]] no unsure On hold until RTCW MP and ET support are done.
[[Return to Castle Wolfenstien (MP) RTCW-MP]] no renderer, cgame, ui (maybe others) On hold while I try to prepare for Spearmint 1.0.
[[Wolfenstien: Enemy Territory EnemyTerritory]] no renderer, cgame, ui (maybe others) ^ Ditto
World of Padman no renderer, client/server, botlib Added new WoP VM API calls for VoIP, missing Ogg Theora playback, also #183, #184, and #185. Missing botlib aas debugging changes, not required to play though. Not started
Smokin' Guns no need to fully review the code Not started Not started
[[Elite Force (MP) EliteForce]] no mp3, renderer Added new shader waveforms, noise and random. Added depthfunc disable (same as depthfunc lequal). Gamecode is under SDK license and cannot be legally ported to Spearmint.
Jedi Outcast (MP) no all As far as I know, the code is GPLv2 (not GPLv2+) (Spearmint is GPLv3+), so currently I will not include any code from it. Full support for JK2/JKA is a low priority right now. no
Jedi Academy (MP) no all Same status as Jedi Outcast. no
Soldier of Fortune II (MP) no all Added a few shader related things. Low priority. no
Heavy Metal: F.A.K.K.2 (FAKK) no unsure Added a few shader related things. Low priority. no
American McGee's Alice no unsure Added a few shader related things. Low priority. no
Star Trek: Elite Force 2 (EF2) no unsure Added a few shader related things. Low priority. no

Spearmint is not compatible with QVMs/DLLs for existing games. Many source code changes are required to port a game/mod to Spearmint.

Spearmint is used by

Released

Yet to be released

Clone this wiki locally