Skip to content

Commit

Permalink
Documentation|Readme: Updated features, acknowledgments, OS X intro
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Jul 9, 2013
1 parent 786398b commit b2e5f24
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 28 deletions.
24 changes: 12 additions & 12 deletions doomsday/doc/readme/credit.ame
Expand Up @@ -17,26 +17,26 @@ implementation and former maintainer of the jDoom Resource Pack.
high-resolution texture packs, and contributor to the
@link{dengine.net}{http://dengine.net} website implementation.

@strong{Vermil} regularly provides in-depth feedback and bug reports and is an
expert in all things related to DOOM-based games.

@strong{Kees Meijs} packaged Doomsday for Debian and hosted an Apt repository
of Debian packages.

@strong{Abbs} maintained the jDoom model pack and did wonderful work on the
models and particle effects.

@strong{Anton Rzheshevski} (aka Cheb) created player weapon 3D models and
other MD2 modifications/enhancements, maintained the jDoom model pack and
wrote KickStart version 2.

@strong{Greg Fisk} (Slyrr) authored many excellent 3D models for jHeretic.

@strong{Daniel Norton} created detail textures for jDoom.
@strong{Andrew Apted} wrote @link{glBSP}{http://glbsp.sourceforge.net/}.

@strong{Graham Jackson} helped with the source code, fixed Doom bugs and did a
lot of testing.

@strong{David Jarvis} did early network testing with jDoom and jHeretic and
generously contributed essential computer hardware components.

@strong{Andrew Apted} wrote @link{glBSP}{http://glbsp.sourceforge.net/}.

@strong{William Mull} hosted the project's websites for many years.

Finally, the resource pack community, particularly mentioning: @strong{Abbs}
maintained the jDoom model pack and did wonderful work on the models and
particle effects; @strong{Anton Rzheshevski} (aka Cheb) created player weapon
3D models and other MD2 modifications/enhancements, maintained the jDoom model
pack and wrote KickStart version 2; @strong{Greg Fisk} (Slyrr) authored many
excellent 3D models for jHeretic; @strong{Daniel Norton} created detail
textures for jDoom.
16 changes: 10 additions & 6 deletions doomsday/doc/readme/features.ame
Expand Up @@ -19,15 +19,15 @@ Graphics:
@item 3D @wikiterm{sky models} and @wikiterm{skyboxes}
}
@item @wikiterm{Particle effects}: point sprite and @wikiterm{3D model particles}
@item Game world @wikiterm{movement smoothing} (actors, monsters, missiles, surfaces)
@item Game world @wikiterm{movement smoothing} (actors, monsters, missiles, surfaces) to remove the original games' limitation of 35 FPS
@item Smart texture filtering using a modified hq2x algorithm
@item Internal enhanced BSP builder (originally based on glBSP)
}

Sound:
Audio:
@list/thin{
@item Uses @link{FMOD Ex}{http://www.fmod.org/} for audio playback (sound effects, music, CD tracks)
@item Supports SDL_mixer for sound effects and music files
@item Also supports the open source SDL_mixer for sound effects and music files
@ifndef{WIN32}{@item FluidSynth for MIDI playback using @wikiterm{SF2} soundfonts}
@ifdef{WIN32}{@item DirectSound3D, EAX 2.0, Windows Multimedia (for MIDI)}
@ifdef{MACOSX}{@item QuickTime for music playback}
Expand All @@ -38,16 +38,20 @@ Sound:
@item Runtime @wikiterm{sound effect resamping} to 22/44 KHz with 8/16 bits
}

Networking:
Multiplayer:
@list/thin{
@item TCP-based client/server @wikilink{networking}{Multiplayer_(Readme)}
@item Up to @wikiterm{15 player games}
@item TCP-based client/server @wikilink{networking}{Multiplayer_(Readme)}
@item Automatical discovery of servers running on the local network
@item Clients can join games in progress
@item Standalone tool called @wikilink{Doomsday Shell}{Shell} for hosting games
}

Other:
@list/thin{
@item Runtime @wikiterm{console}
@item Overlaid @wikiterm{task bar} and @wikiterm{console}
@item Game can be changed on the fly (for example from Doom to Heretic)
@item Graphical @wikilink{game selection screen}{Ringzero_GUI}
@item @wikiterm{Control panel}: engine configuration
@item Flexible input control @wikiterm{bindings} system
@item Plain text definition files (@wikiterm{DED}) for game objects and other data
Expand Down
20 changes: 10 additions & 10 deletions doomsday/doc/readme/introbrief.ame
Expand Up @@ -14,17 +14,17 @@ early 2000. Several people have been involved in the project (see
@ifdef{MACOSX}{
@section{How to install}

The @strong{Doomsday.pkg} installer package contains the @strong{Doomsday
Engine} and @strong{Doomsday Shell} applications.

When you open @strong{Doomsday Engine}, a launcher frontend
will appear. The first time you start the application, a setup wizard will
guide you through setting up some game profiles.
The @strong{Doomsday.pkg} installer package contains two applications:
@list{
@item @strong{Doomsday Engine}: launcher frontend for starting Doomsday
@item @strong{Doomsday Shell}: tool for running and monitoring your own
multiplayer servers (introduced in version 1.10)
}

@strong{Doomsday Shell} is a tool for running and monitoring your own
multiplayer servers.
The first time you start the frontend, a setup wizard will guide you through
setting up some game profiles.

To uninstall Doomsday, just move @strong{Doomsday Engine} and @strong{Doomsday
Shell} to the Trash.
To uninstall, move @strong{Doomsday Engine} and @strong{Doomsday Shell} to the
Trash. If you wish to also delete your frontend game profiles, savegames and other persistent data, delete the @file{~/Library/Application Support/Doomsday Engine} folder.

}

0 comments on commit b2e5f24

Please sign in to comment.