Skip to content

Home

Jump to bottom
Zack Middleton edited this page Oct 22, 2013 · 134 revisions

Spearmint is a fork of ioquake3 that was created to be a base engine for developing new standalone id Tech 3 games. Spearmint is not compatible with Quake III Arena mods (the QVM/DLL files) or demos. Spearmint can be used with the Quake III Arena (and optionally its expansion Quake III: Team Arena) or compatible replacement data.

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

Features

  • Four player splitscreen, offline and in network games.
  • Extended API for Game and CGame/UI, includes some of the features from RTCW, WolfET, Tremulous, World of Padman, and Turtle Arena.
  • Additional shader settings.
  • Merged UI VM into CGame VM, easier to modify and uses less resources.
  • Moved a lot of code from server and client to Game and CGame VMs; including console, chat input overlay, usercmd_t creation, and a lot of bot AI code.
  • Removed code not needed for standalone games (CD Key handling, authentication server code, sending pk3 checksums to server, and PunkBuster UI code).
  • Ogg Opus, Ogg Vorbis, FreeType support enabled by default. Source and headers included in local source tree for easy compiling.

See Roadmap and issues list for future plans.

Current Focus

Updated October 11 2013

  • Merge Turtle Arena's engine with Spearmint so that TA can run on Spearmint.
    • Add renderer features and move console to cgame.

Recent focus, probably get back to soon-ish

  • Add/fix rendering features for RTCW (MP) and ET maps
  • Add engine features (VM system calls) required for RTCW (MP) and ET
  • Improve/finish supporting multiple games on a single id Tech 3 engine. (Move messagemode and console to cgame. Customize loading screen via gameconfig.txt. Etc.)

Documentation

Features

Tutorials

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

Built on the shoulders of giants.

  • 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)
  • Zack Middleton (spearmint developer)

Engine Feature Support

Game All Needed Features Lacking Areas Status Ported to Spearmint?
Quake III Arena yes none Complete In Spearmint code repo
Quake III: Team Arena yes none Complete In Spearmint code repo
Q3Rally (Standalone) yes none Complete Not started
Tremulous yes game, ui Need system traps for getting news (ui) and sending game stats to master server (game) Not started
Turtle Arena / Extraordinary Beat X no unsure Working on it, hopefully done before end of 2013 Native
[[Return to Castle Wolfenstien (SP) RTCW-SP]] no unsure On hold until RTCW MP, ET, Turtle Arena support are done.
[[Return to Castle Wolfenstien (MP) RTCW-MP]] no renderer, cgame, ui (maybe others) Working on it, hopefully done before end of 2013
[[Wolfenstien: Enemy Territory EnemyTerritory]] no renderer, cgame, ui (maybe others) Working on it, hopefully done before end of 2013
World of Padman no need to fully review the client/server code Added new WoP vm API calls, missing Ogg Theora playback Not started
Smokin' Guns no need to fully review the code Not started Not started
[[Elite Force (MP) EliteForce]] no mp3, renderer (maybe others) Added new shader waveforms, noise and random. May not be fully compatible, because mod code SDK license forbids using with different game or whatever
Jedi Outcast (MP) no all It's not clear if code is GPLv2 or GPLv2+ (Spearmint is GPLv3+), might not be able to include code from it. Though it's unlikely I would want to add all the required features at this point anyway. no
Jedi Academy (MP) no all Same status as Jedi Outcast no

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

If have all needed features for a game, then it should be possible to port the game to be a mod for Spearmint. Depending on "Lacking Areas", there may be some missing functionality which was determined to not effect general usage (for example Tremulous' UI system call trap_GetNews).

"All Needed Features" and "Lacking Areas" apply to mods for each game as well.

Spearmint is used by

Released

Yet to be released

Clone this wiki locally