Skip to content

Home

Jump to bottom
zturtleman edited this page Jan 4, 2013 · 134 revisions

Spearmint is a fork of ioquake3 with fixes and features that don't fit in ioquake3 for one reason or another. It was created to be a better (or alternative) 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 data files (and optionally Quake III: Team Arena data files) or compatible replacement data.

Spearmint is currently rapidly changing / breaking mod API and network compatibility. Eventually the mod API and networking protocol will be stable (at least, that's the plan).

Spearmint is used by Turtle Arena, ioid3, and Mecwerks.

Major Features

  • Four player splitscreen, offline and in network games
  • Extended API for game, cgame, and ui, includes some of the features from RTCW, WolfET, Tremulous, and World of Padman
  • Improved game, cgame, and ui API version handling
  • Modified pure pk3 system (if a default pk3 is missing or modified, allow game to be played but don't allow enabling sv_pure cvar)
  • Removed code not needed for standalone games (CD Key handling, authentication server code, and punkbuster ui code)
  • Ogg Vorbis support enabled by default, source and headers included in local source tree for easy compiling
  • FreeType support enabled by default, source and headers included in local source tree for easy compiling
  • Capsule collision support, enabled for players by default. (Note: There are currently some bugs being worked out.)

Future Plans

  • Support for using a single IQM skeleton animated model for playable characters.
  • Ogg Theora video playback support, possibly using TheoraPlay.
  • Merge many bug fixes and features from Turtle Arena, Tremulous, Wolfenstein: Enemy Territory, and other id Tech 3 games.

See Roadmap for more.

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 Wolfenstein: Enemy Territory and Doom 3.

Tutorials

  • [New Game](New Game) -- Information about changing the engine game, data paths, etc.
  • [New Sounds](New Sounds) -- Information about sounds new games might want to add.
  • http://www.mecwerks.com/tutorials -- Various programming tutorials for Spearmint by mecenefeaa.

Links

  • [http://ztm.x10host.com/2011/08/23/new-ioq3-fork-ioq3ztm/ New ioq3 fork, ioq3ztm] - ZTurtleMan's blog post announcing/describing ioq3ztm (now named Spearmint).

Clone this wiki locally