From f588a26f5e854e5cec0edff36e5b23cc26c45813 Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 19:59:45 -0400 Subject: [PATCH 1/7] README: Deemphasize compatibility This moves the paragraph about compatibility further down the page into its own section. I am *not* doing this because we are deemphasizing compatibility as a project goal; rather, I'm doing this because I want to *emphasize* the idea of Freedoom being its own independent game. The idea here is to try to get away from the misconception some people have that the goal of Freedoom is to be a "clone" of Doom. --- README.adoc | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.adoc b/README.adoc index b5d1e1da..5f316fbc 100644 --- a/README.adoc +++ b/README.adoc @@ -5,11 +5,6 @@ person shooter game, but _Freedoom_ by itself is just the raw material for a game. It must be paired with a compatible _Doom_ engine to be played. -There is a massive https://doomwiki.org/wiki/Idgames_archive[back -catalog], spanning over two decades, containing thousands of _Doom_ -levels and other modifications (“mods”) made by fans of the game. -_Freedoom_ aims to be compatible with these and allows most to be -played without the need to use non-free software. _Freedoom_ is actually three games in one, consisting of two single-player oriented campaigns and one set of levels designed @@ -84,6 +79,16 @@ engine for proper play. Desktop files may also be installed so that you can start the game using a graphical interface and avoid the command line altogether. +== Compatibility + +A secondary goal of Freedoom is _compatibility_ with modifications +("mods") for the original Doom. There is a massive +https://doomwiki.org/wiki/Idgames_archive[back catalog], spanning over +two decades, containing thousands of _Doom_ levels and other +mods made by fans of the game. _Freedoom_ aims to be compatible with +these and allows most to be played without the need to use non-free +software. + == What “free” means When we speak of free content or software, we refer to the movement in From 1187d3c102a38a68af5fb83cb937655ccedf982d Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 20:04:40 -0400 Subject: [PATCH 2/7] README: Reword intro section The previous wording ("but Freedoom by itself is just...") read like we were putting the project down a bit. Let's not do ourselves a disservice. A second paragraph further down was framing us in terms of being a "free alternative" to Doom. Let's ditch that; we are our own game. We can also leave out the technical jargon about IWADs etc. --- README.adoc | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.adoc b/README.adoc index 5f316fbc..859c188b 100644 --- a/README.adoc +++ b/README.adoc @@ -1,10 +1,12 @@ = Freedoom The Freedoom project aims to create a complete, free content first -person shooter game, but _Freedoom_ by itself is just the raw material -for a game. It must be paired with a compatible _Doom_ engine to be -played. +person shooter game, based on the _Doom_ engine. +_Freedoom_ is not a program - rather, it consists of the levels, +artwork, sound effects and music that make up the game. To play +_Freedoom_, <> that +can play it. _Freedoom_ is actually three games in one, consisting of two single-player oriented campaigns and one set of levels designed @@ -19,15 +21,6 @@ monsters and a double-barrelled shotgun. This project aims for compatibility with _Doom II_ mods. *FreeDM*:: A 32-level game designed for competitive deathmatch play. -The engine uses a single file, such as +freedoom2.wad+, that contains -all the game data such as graphics, sound effects, music, and so on. -This file is often called an “IWAD” by those in the _Doom_ and -_Freedoom_ communities. While the _Doom_ engine source code is free, -you would normally still need one of the proprietary data files from -https://www.idsoftware.com/[id Software] to play _Doom_. _Freedoom_ -aims to create a free alternative: combined with the GPL-licensed -_Doom_ source code, this results in a completely free game. - For more information, see https://freedoom.github.io/. == How to play From 778525b5f12078c12b673cb32cd360b2032910d9 Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 20:10:20 -0400 Subject: [PATCH 3/7] README: Delete paragraph/list about renaming IWADs These instructions are workarounds for the fact that we renamed the IWAD files many moons back (see [1]). All source ports have caught up with the new IWAD names by now, and we can just delete the text. [1] - https://www.doomworld.com/forum/topic/66856-bikeshedding-renaming-freedooms-iwads/ --- README.adoc | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README.adoc b/README.adoc index 859c188b..f20969df 100644 --- a/README.adoc +++ b/README.adoc @@ -43,34 +43,12 @@ or your home directory. If _Freedoom_ comes packaged as part of your operating system distribution, it should already be installed into the proper location. -Hopefully, your engine of choice should already be capable of running -_Freedoom_ without extra configuration. This may not be the case, -however, if the engine does not recognize any of the filenames for -_Freedoom_, and might require manual intervention to make it so. One -of the following options should solve it: - - * Use the +-iwad+ command line parameter. For example, to play - Phase 2, you can enter +-iwad freedoom2.wad+ either at a command - line, or adding it to an application shortcut. - * Use the +DOOMWADPATH+ environment variable. Many engines support - this variable to add directories and/or files to their search - path. The exact syntax matches your operating system’s normal - +PATH+ environment variable. - * Rename the game files. This may be a bit crude, but you can - rename the files to match those of _Doom_’s. This is often the - easiest quick-fix, although it is normally desirable to use one of - the above methods if possible. - - ** +freedoom1.wad+ can be renamed to +doom.wad+ - ** +freedoom2.wad+ can be renamed to +doom2.wad+ - ** +freedm.wad+ can be renamed to +doom2.wad+ - -Additionally, for Unix-like operating systems, such as GNU/Linux or a -BSD variant, _Freedoom_ may be packaged and installed with programs -named +freedoom1+, +freedoom2+, and +freedm+ that automatically run an -engine for proper play. Desktop files may also be installed so that -you can start the game using a graphical interface and avoid the -command line altogether. +For Unix-like operating systems, such as GNU/Linux or a BSD variant, +_Freedoom_ may be packaged and installed with programs named ++freedoom1+, +freedoom2+, and +freedm+ that automatically run an engine +for proper play. Desktop files may also be installed so that you can +start the game using a graphical interface and avoid the command line +a ltogether. == Compatibility From 3c71678ea2424862cbff5787b45a1fe1faa1c5ad Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 20:14:44 -0400 Subject: [PATCH 4/7] README: Make IP advice more explicit/forceful The previous text was couching its words a lot ("don't emulate... exactly", "this is a tough call"). Let's be more explicit and emphasize that work should be original and not a clone of Doom. Besides being safer from a legal standpoint, it's a better goal for the project in general. --- README.adoc | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index f20969df..21d3cb64 100644 --- a/README.adoc +++ b/README.adoc @@ -99,10 +99,11 @@ The general rules go as follows: permission to include it in the _Freedoom_ project. They may not place additional restrictions compared to the normal _Freedoom_ license. - * Do not try to emulate _Doom_ resources exactly. Where possible, - put effort to make new versions look visibly different from - _Doom_. This is a tough call, because our compatibility with - _Doom_ mods limits how far we can deviate, but it is feasible. + * Freedoom's name often leads some people to think that the project's + goal is to make a "free clone of Doom". This is not the case! While + compatibility 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 to be okay to use, many are free for “non-commercial use only.” From 179cbfb47f7857f97a824d2cfc8260904cd9a782 Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 20:24:41 -0400 Subject: [PATCH 5/7] README: Reword the introductory sentence We aren't just "aiming to create a complete game" - Freedoom *is* a complete game, and has been for a long time now! --- README.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 21d3cb64..e76c5d5a 100644 --- a/README.adoc +++ b/README.adoc @@ -1,7 +1,7 @@ = Freedoom -The Freedoom project aims to create a complete, free content first -person shooter game, based on the _Doom_ engine. +_Freedoom_ is a complete, free content first person shooter game, +based on the _Doom_ engine. _Freedoom_ is not a program - rather, it consists of the levels, artwork, sound effects and music that make up the game. To play From b964f4dca34d6125b2cfd5dd48184ee46fda26ce Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 20:36:06 -0400 Subject: [PATCH 6/7] README: Add brief section about the game manual --- README.adoc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.adoc b/README.adoc index e76c5d5a..7b7eb2d9 100644 --- a/README.adoc +++ b/README.adoc @@ -50,6 +50,15 @@ for proper play. Desktop files may also be installed so that you can start the game using a graphical interface and avoid the command line a ltogether. +== Manual + +Freedoom has a complete PDF format manual that describes how to play the +game, including an introductory tutorial and some tactical tips. It also +has information on the monsters and power-ups you'll encounter during +play. The manual is available in multiple languages and can be +downloaded https://freedoom.github.io/manual.html[on the website]. +Printed, physical manuals are also available for purchase. + == Compatibility A secondary goal of Freedoom is _compatibility_ with modifications From ea7c66fb25de61efd16ea161814c18eafc9270ac Mon Sep 17 00:00:00 2001 From: Simon Howard Date: Tue, 24 Jun 2025 20:41:35 -0400 Subject: [PATCH 7/7] README: An update: over 30 years of mods now! --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 7b7eb2d9..262817d9 100644 --- a/README.adoc +++ b/README.adoc @@ -64,7 +64,7 @@ Printed, physical manuals are also available for purchase. A secondary goal of Freedoom is _compatibility_ with modifications ("mods") for the original Doom. There is a massive https://doomwiki.org/wiki/Idgames_archive[back catalog], spanning over -two decades, containing thousands of _Doom_ levels and other +three decades, containing thousands of _Doom_ levels and other mods made by fans of the game. _Freedoom_ aims to be compatible with these and allows most to be played without the need to use non-free software.