- Notifications
You must be signed in to change notification settings - Fork219
Freedoom is an entirely free software game based on the Doom engine.
License
freedoom/freedoom
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Freedoom is a complete, free content first person shooter game,based on theDoom engine.
Freedoom is not a program - rather, it consists of the levels,artwork, sound effects and music that make up the game. To playFreedoom,it must be paired with an engine thatcan play it.
Freedoom is actually three games in one, consisting of twosingle-player oriented campaigns and one set of levels designedexclusively for multiplayer deathmatch:
Freedoom: Phase 1 | Four episodes, nine levels each, totalling 36levels. This game aims for compatibility withThe Ultimate Doommods, also known as plainDoom orDoom 1. |
Freedoom: Phase 2 | 32 levels in one long episode, featuring extramonsters and a double-barrelled shotgun. This project aims forcompatibility withDoom II mods. |
FreeDM | A 32-level game designed for competitive deathmatch play. |
For more information, seehttps://freedoom.github.io/.
SinceFreedoom is only the game data, you will still need todownload an engine separately. These are also often termed “sourceports” by the community. There are an overwhelming number of choicesavailable, a lengthy list of which is available on theDoom Wiki.
One particularly recommended by theFreedoom project isGZDoom. This engine offers good support forsingle-player, multi-player, and the majority of mods created for bothDoom andFreedoom.
On Windows, you should placeFreedoom’s data files (those endingwith .wad) alongside the engine (eg, odamex.exe). On Unix-likesystems, these data files should go in either /usr/share/games/doomor your home directory. IfFreedoom comes packaged as part of youroperating system distribution, it should already be installed into theproper location.
For Unix-like operating systems, such as GNU/Linux or a BSD variant,Freedoom may be packaged and installed with programs namedfreedoom1, freedoom2, and freedm that automatically run an enginefor proper play. Desktop files may also be installed so that you canstart the game using a graphical interface and avoid the command linea ltogether.
Freedoom has a complete PDF format manual that describes how to play thegame, including an introductory tutorial and some tactical tips. It alsohas information on the monsters and power-ups you’ll encounter duringplay. The manual is available in multiple languages and can bedownloadedon the website.Printed, physical manuals are also available for purchase.
A secondary goal of Freedoom iscompatibility with modifications("mods") for the original Doom. There is a massiveback catalog, spanning overthree decades, containing thousands ofDoom levels and othermods made by fans of the game.Freedoom aims to be compatible withthese and allows most to be played without the need to use non-freesoftware.
When we speak of free content or software, we refer to the movement inwhich your freedoms to use, copy, modify, and study a work is notinfringed. For example, you may freely useFreedoom for any purposeyou see fit, you may redistribute it to anyone without needing to askfor permission, you may modify it (provided you keep the licenseintact, seeCOPYING
), and you may study it—for example, to see howan “IWAD” is built. To facilitate this, you can get the full sourcecode forFreedoom, in this case, in the form of a DeuTex tree.
You may read more about free software at theGNUandFree Software Foundation websites.
Contributions toFreedoom are always welcome, however there are afew guidelines that should be followed:
We know people hate legalese, but this is important. This applies toeverything which is submitted.
You must be careful when basing on existing graphics or sounds. MostDoom projects are lax on reusing intellectual property—there aremany mods which contain modifiedDoom sprites, for example.However, due to the nature of this project, we do not have the sameliberty to rip as we please.
The general rules go as follows:
You must have permission for everything you submit. If you makeyour own resources, do not base on resources fromDoom or anyother restricted work. If you take work from other places, pleasemake sure that the work is freely-licensed or that you obtainpermission to include it in theFreedoom project. They may notplace additional restrictions compared to the normalFreedoomlicense.
Freedoom’s name often leads some people to think that the project’sgoal is to make a "free clone of Doom". This is not the case! Whilecompatibility with Doom is a goal, we are our building our own game.Please make an effort to ensure your work is original and distinct,and not just a copy of anything from Doom.
Be especially careful of “free textures” (or “free sounds” or“free graphics”) sites. Although these would appear at first tobe okay to use, many are free for “non-commercial use only.”One of the things we want to be able to do is put this inGNU/Linux distributions (which can be sold or developedcommercially).
All levels forFreedoom must be vanilla-compatible, requiring anexpanded-limits or limit-removing engine is not permissible. Thismeans you may not exceed the limits of the originalDoom engine, anddo not depend on additional mapping features. Levels should be inDoom’s original format, not in “Hexen”-format.
It is sensible to also heed the following guidelines:
Make sure that skill levels are implemented, and that allmultiplayer start points, both cooperative and deathmatch, arepresent.
Try to make levels appropriately difficult for their positionwithin the progression of the game. Also bear in mind that notall players may be as skilled a player as you.
Do not use tricks that exploitDoom’s software renderer; someengines, especially those that use hardware accelerated rendering,may not render it properly. Examples of tricks to avoid includethose used to simulate 3D bridges and “deep water” effects.
Test your levels inChocolateDoom to make sure that vanilla compatibility is maintained. Thisis an engine with strict adherence to vanilla Doom limits andbugs, and working in it assures that levels can be played with anyDoom engine.
Use a Doom editor to check for errors. InEureka it’s possible tocheck for errors with the Check / All menu, or by pressing
F9
.If possible run
make test
and fix any errors found. Note thatsome of the errors can be fixed bymake fix
.
Graphics should generally have the same color and size as the originalDoom graphics, as to remain compatible with mods. Otherwise, levelsmay end up looking like a nightmare in design. They may bethematically different as long as it doesn’t clash.
Doom uses a fictional corporation abbreviated as “UAC:” this istrademarked by id Software and cannot be used inFreedoom. Instead,use the initials “AGM” forFreedoom.
Freedoom always needs help with documentation, so please send yourpatches, but keep in mind:
We useAsciiDoc for writing thedocumentation. AsciiDoc is a simple plaintext-based format whichis simple to read and write in its source form, and can generatenice HTML documents out of them.
Headers are formated in a wiki-style format, this makes it easierfor Vim (perhaps other editors, too) to automatically re-formattext.
Text is kept at 72 characters wide. In Vim, you can set theeditor to automatically insert line breaks as you’re typing byperforming
set textwidth=72
. Special exceptions to the widthrule might be allowed when necessary (for example, inserting longURLs).
The most common, and a fairly simple method, to submit your work is byposting it on theFreedoom forum onDoomworld Forums. This allows a great number of people to review thecontribution and provide feedback, although the registration processis known to be cumbersome.
An alternative to using the forum, is to post your submission on theissue tracker, which mayalso be peer-reviewed and provide a feedback cycle.
Unfortunately, the Freedoom project cannot provide hosting space inthe form of a web page nor FTP, however there are many free file hoststo use when you need a location to upload files. Sites and servicessuch asDropbox andMega, as well as others, are common and should besimple to use.
Freedoom is made up of submissions from many people all over theglobe. All of them, and you, deserve credit! Please do not forget toprovide your name and email when submitting resources.
You can also commit on a clone of theFreedoom repository, althoughthis is a technical task and it is okay to let otherFreedoommaintainers to do it instead: that is our normal mode of operation.However, pull requests are much appreciated and you may submit them inany manner you wish, with GitHub’s direct pull requests being thesimplest, but by far not the only means.
Freedoom uses the commit message style commonly seen in distributedversion control systems, adopted by projects such as Linux and Git.For an explanation of this style, seeHow to Write a Git CommitMessage.
If you create a git commit for someone else it is helpful to set theauthor of the commit so that they get credit. Ask them what name/aliasand email they would like to use. For example:
git commit --author"Bob Smith <bob@example.com>" ...
If they prefer not to give an email then the email can be omitted, sojust "Bob Smith" in the above example.
About
Freedoom is an entirely free software game based on the Doom engine.
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.