mirror of
https://github.com/freedoom/freedoom.git
synced 2025-09-01 04:25:45 -04:00
README: Etch out Boom, etch in limit removing.
Most maps in Freedoom have been converted to a limit removing target as an interim goal for 1.0’s ultimate goal of vanilla compatibility. We can stop saying Boom compatibility is required now.
This commit is contained in:
parent
b5bcdf0c62
commit
717817e714
1 changed files with 28 additions and 32 deletions
60
README.adoc
60
README.adoc
|
@ -55,16 +55,16 @@ operating system distribution, it should already be installed into the
|
||||||
proper location.
|
proper location.
|
||||||
|
|
||||||
If you wish to venture outside of Odamex, beware that _Phase 1_ and
|
If you wish to venture outside of Odamex, beware that _Phase 1_ and
|
||||||
_Phase 2_ require a Boom-compatible engine, which is thankfully the
|
_Phase 2_ require a https://doomwiki.org/wiki/Limit_removing[limit
|
||||||
majority of them, but without compatibility, some aspects of the game
|
removing] engine, which is thankfully the majority of them, but
|
||||||
may not run properly. _FreeDM_, on the other hand, is intended to be
|
not all. _FreeDM_, on the other hand, is intended to be playable by
|
||||||
playable by all variants of the _Doom_ engine.
|
all variants of the _Doom_ engine.
|
||||||
|
|
||||||
Hopefully, your engine of choice should already be capable of running
|
Hopefully, your engine of choice should already be capable of running
|
||||||
_Freedoom_ without extra configuration. This may not be the case,
|
_Freedoom_ without extra configuration. This may not be the case,
|
||||||
however, if the engine does not recognize any of the filenames for
|
however, if the engine does not recognize any of the filenames for
|
||||||
Freedoom, and might require manual intervention to make it so. One of
|
_Freedoom_, and might require manual intervention to make it so. One
|
||||||
the following options should solve it:
|
of the following options should solve it:
|
||||||
|
|
||||||
* Use the +-iwad+ command line parameter. For example, to play
|
* Use the +-iwad+ command line parameter. For example, to play
|
||||||
Phase 2, you can enter +-iwad freedoom2.wad+ either at a command
|
Phase 2, you can enter +-iwad freedoom2.wad+ either at a command
|
||||||
|
@ -100,15 +100,15 @@ you see fit, you may redistribute it to anyone without needing to ask
|
||||||
for permission, you may modify it (provided you keep the license
|
for permission, you may modify it (provided you keep the license
|
||||||
intact, see `COPYING`), and you may study it--for example, to see how
|
intact, see `COPYING`), and you may study it--for example, to see how
|
||||||
an “IWAD” is built. To facilitate this, you can get the full source
|
an “IWAD” is built. To facilitate this, you can get the full source
|
||||||
code for Freedoom, in this case, in the form of a DeuTex tree.
|
code for _Freedoom_, in this case, in the form of a DeuTex tree.
|
||||||
|
|
||||||
You may read more about free software at the http://www.gnu.org/[GNU]
|
You may read more about free software at the http://www.gnu.org/[GNU]
|
||||||
and http://www.fsf.org/[Free Software Foundation] websites.
|
and http://www.fsf.org/[Free Software Foundation] websites.
|
||||||
|
|
||||||
== Contributing to Freedoom
|
== Contributing to Freedoom
|
||||||
|
|
||||||
Contributions to Freedoom are always welcome, however there are a few
|
Contributions to _Freedoom_ are always welcome, however there are a
|
||||||
guidelines that should be followed:
|
few guidelines that should be followed:
|
||||||
|
|
||||||
=== Intellectual property
|
=== Intellectual property
|
||||||
|
|
||||||
|
@ -143,21 +143,22 @@ The general rules go as follows:
|
||||||
|
|
||||||
=== Levels
|
=== Levels
|
||||||
|
|
||||||
Levels for _Phase 1_ and _Phase 2_ should be compatible with Boom
|
Levels for _Phase 1_ and _Phase 2_ must be compatible with any limit
|
||||||
2.02: a _Doom_-derived engine which is a common ancestor for many
|
removing engine. This means that you may exceed the limits of the
|
||||||
engines today. Its extensions are even commonly reimplemented by
|
original _Doom_, but do not depend on any additional mapping features.
|
||||||
engines which are not descended from Boom. This means that you may
|
Levels should be in _Doom_'s original format, not in “Hexen”-format.
|
||||||
exceed the limits of the original _Doom_ and use features introduced
|
|
||||||
in Boom. Do not use features that are not supported by Boom 2.02 and
|
It is a goal that future versions of _Freedoom_ will be entirely
|
||||||
compatible engines. Levels should be in _Doom_'s original format, not
|
vanilla-compatible, not even allowing expanded limits. Keeping this
|
||||||
in “Hexen”-format.
|
in mind while mapping may make it easier for your level to be
|
||||||
|
preserved. Levels requiring large amounts of modification to fit into
|
||||||
|
vanilla limits may be discarded entirely in favor of a simple map.
|
||||||
|
|
||||||
Levels for _FreeDM_ must strictly be vanilla-compatible, that is, they
|
Levels for _FreeDM_ must strictly be vanilla-compatible, that is, they
|
||||||
must run in the original +doom2.exe+ engine for DOS and not cause any
|
must run in the original +doom2.exe+ engine for DOS and not cause any
|
||||||
visplane overflows and other such problems in the vanilla engine.
|
visplane overflows and other such problems in the vanilla engine.
|
||||||
This ensures the maximum compatibility with all _Doom_-derived
|
This ensures the maximum compatibility with all _Doom_-derived
|
||||||
engines, including those that do not descend from nor support Boom
|
engines.
|
||||||
features.
|
|
||||||
|
|
||||||
It is sensible to also heed the following guidelines:
|
It is sensible to also heed the following guidelines:
|
||||||
|
|
||||||
|
@ -171,24 +172,19 @@ It is sensible to also heed the following guidelines:
|
||||||
engines, especially those that use hardware accelerated rendering,
|
engines, especially those that use hardware accelerated rendering,
|
||||||
may not render it properly. Examples of tricks to avoid include
|
may not render it properly. Examples of tricks to avoid include
|
||||||
those used to simulate 3D bridges and “deep water” effects.
|
those used to simulate 3D bridges and “deep water” effects.
|
||||||
* Boom removes almost all of the limits on rendering; however, do
|
* While unrestricted by limits, do not make excessively complicated
|
||||||
not make excessively complicated scenes. It is desirable that
|
scenes. It is desirable that _Freedoom_ levels should be playable
|
||||||
Freedoom levels should be playable on low-powered hardware, such
|
on low-powered hardware, such as phones and old computers.
|
||||||
as phones and old computers.
|
* For _Phase 1_ and _Phase 2_, try to test your levels in
|
||||||
* For _Phase 1_ and _Phase 2_, try to test in
|
http://fabiangreffrath.github.io/crispy-doom[Crispy Doom], which
|
||||||
http://www.teamtnt.com/boompubl/boom2.htm[Boom] towards the end of
|
is an engine that is limit removing but does not introduce mapping
|
||||||
your level creation process, before submission. Incompatibilities
|
features to accidentally exploit.
|
||||||
will usually be discovered before a release, but it will help to
|
|
||||||
be sure yourself. Since using a DOS-compatible operating system
|
|
||||||
is uncommon these days, you may need to use
|
|
||||||
http://www.dosbox.com/[DOSBox] or similar virtual machine software
|
|
||||||
to run Boom.
|
|
||||||
* For _FreeDM_, while you can test in the original +doom2.exe+
|
* For _FreeDM_, while you can test in the original +doom2.exe+
|
||||||
engine with DOS or an emulator, this original engine is not free
|
engine with DOS or an emulator, this original engine is not free
|
||||||
software and not legally obtainable without _Doom_, in addition to
|
software and not legally obtainable without _Doom_, in addition to
|
||||||
the hassle of merely running it.
|
the hassle of merely running it.
|
||||||
http://www.chocolate-doom.org/[Chocolate Doom] is a free software,
|
http://www.chocolate-doom.org/[Chocolate Doom] is a free software,
|
||||||
highly-portable, and strictly-vanilla-compatible engine without
|
highly-portable, and strictly vanilla-compatible engine without
|
||||||
any extra features for levels, suitable for testing FreeDM.
|
any extra features for levels, suitable for testing FreeDM.
|
||||||
|
|
||||||
=== Graphics
|
=== Graphics
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue