-
Notifications
You must be signed in to change notification settings - Fork 36
Home
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 (game that started Spearmint development)
- Extraordinary Beat X (EBX) (based on Turtle Arena)
- Mecwerks
- ioid3 (no longer under development)
- 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, see PAKSUMS
- 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.)
| 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 | server, game, ui | Hopefully be complete soon | Not started |
| Turtle Arena / Extraordinary Beat X | no | all? | Working on it | Native |
| Return to Castle Wolfenstien (SP and MP) | no | renderer, cgame, ui (maybe others) | Going to be awhile | Not started |
| Wolfenstien: Enemy Territory | no | renderer, cgame, ui (maybe others) | Going to be awhile | Not started |
| Elite Force (MP) | no | renderer (maybe others) | probably not ever going to be fully compatible, because probably not going to ever port mod code | Probably not going to happen due to mod code SDK license |
| Smokin' Guns | no | need to fully review the code | Not started | Not started |
| World of Padman | unknown | need to fully review the code | Started | Not started |
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.
- 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.
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.
- New Game -- Information about changing the engine game, data paths, etc.
- New Sounds -- Information about sounds new games might want to add.
- http://www.mecwerks.com/tutorials -- Various programming tutorials for Spearmint by mecenefeaa.
- New ioq3 fork, ioq3ztm - ZTurtleMan's blog post announcing/describing ioq3ztm (now named Spearmint).