| 0,0 → 1,962 |
|---|
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> |
| <meta name="generator" content="AsciiDoc 8.6.9" /> |
| <title>Freedoom</title> |
| <style type="text/css"> |
| /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ |
| |
| /* Default font. */ |
| body { |
| font-family: Georgia,serif; |
| } |
| |
| /* Title font. */ |
| h1, h2, h3, h4, h5, h6, |
| div.title, caption.title, |
| thead, p.table.header, |
| #toctitle, |
| #author, #revnumber, #revdate, #revremark, |
| #footer { |
| font-family: Arial,Helvetica,sans-serif; |
| } |
| |
| body { |
| margin: 1em 5% 1em 5%; |
| } |
| |
| a { |
| color: blue; |
| text-decoration: underline; |
| } |
| a:visited { |
| color: fuchsia; |
| } |
| |
| em { |
| font-style: italic; |
| color: navy; |
| } |
| |
| strong { |
| font-weight: bold; |
| color: #083194; |
| } |
| |
| h1, h2, h3, h4, h5, h6 { |
| color: #527bbd; |
| margin-top: 1.2em; |
| margin-bottom: 0.5em; |
| line-height: 1.3; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: 2px solid silver; |
| } |
| h2 { |
| padding-top: 0.5em; |
| } |
| h3 { |
| float: left; |
| } |
| h3 + * { |
| clear: left; |
| } |
| h5 { |
| font-size: 1.0em; |
| } |
| |
| div.sectionbody { |
| margin-left: 0; |
| } |
| |
| hr { |
| border: 1px solid silver; |
| } |
| |
| p { |
| margin-top: 0.5em; |
| margin-bottom: 0.5em; |
| } |
| |
| ul, ol, li > p { |
| margin-top: 0; |
| } |
| ul > li { color: #aaa; } |
| ul > li > * { color: black; } |
| |
| .monospaced, code, pre { |
| font-family: "Courier New", Courier, monospace; |
| font-size: inherit; |
| color: navy; |
| padding: 0; |
| margin: 0; |
| } |
| pre { |
| white-space: pre-wrap; |
| } |
| |
| #author { |
| color: #527bbd; |
| font-weight: bold; |
| font-size: 1.1em; |
| } |
| #email { |
| } |
| #revnumber, #revdate, #revremark { |
| } |
| |
| #footer { |
| font-size: small; |
| border-top: 2px solid silver; |
| padding-top: 0.5em; |
| margin-top: 4.0em; |
| } |
| #footer-text { |
| float: left; |
| padding-bottom: 0.5em; |
| } |
| #footer-badges { |
| float: right; |
| padding-bottom: 0.5em; |
| } |
| |
| #preamble { |
| margin-top: 1.5em; |
| margin-bottom: 1.5em; |
| } |
| div.imageblock, div.exampleblock, div.verseblock, |
| div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| div.admonitionblock { |
| margin-top: 1.0em; |
| margin-bottom: 1.5em; |
| } |
| div.admonitionblock { |
| margin-top: 2.0em; |
| margin-bottom: 2.0em; |
| margin-right: 10%; |
| color: #606060; |
| } |
| |
| div.content { /* Block element content. */ |
| padding: 0; |
| } |
| |
| /* Block element titles. */ |
| div.title, caption.title { |
| color: #527bbd; |
| font-weight: bold; |
| text-align: left; |
| margin-top: 1.0em; |
| margin-bottom: 0.5em; |
| } |
| div.title + * { |
| margin-top: 0; |
| } |
| |
| td div.title:first-child { |
| margin-top: 0.0em; |
| } |
| div.content div.title:first-child { |
| margin-top: 0.0em; |
| } |
| div.content + div.title { |
| margin-top: 0.0em; |
| } |
| |
| div.sidebarblock > div.content { |
| background: #ffffee; |
| border: 1px solid #dddddd; |
| border-left: 4px solid #f0f0f0; |
| padding: 0.5em; |
| } |
| |
| div.listingblock > div.content { |
| border: 1px solid #dddddd; |
| border-left: 5px solid #f0f0f0; |
| background: #f8f8f8; |
| padding: 0.5em; |
| } |
| |
| div.quoteblock, div.verseblock { |
| padding-left: 1.0em; |
| margin-left: 1.0em; |
| margin-right: 10%; |
| border-left: 5px solid #f0f0f0; |
| color: #888; |
| } |
| |
| div.quoteblock > div.attribution { |
| padding-top: 0.5em; |
| text-align: right; |
| } |
| |
| div.verseblock > pre.content { |
| font-family: inherit; |
| font-size: inherit; |
| } |
| div.verseblock > div.attribution { |
| padding-top: 0.75em; |
| text-align: left; |
| } |
| /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ |
| div.verseblock + div.attribution { |
| text-align: left; |
| } |
| |
| div.admonitionblock .icon { |
| vertical-align: top; |
| font-size: 1.1em; |
| font-weight: bold; |
| text-decoration: underline; |
| color: #527bbd; |
| padding-right: 0.5em; |
| } |
| div.admonitionblock td.content { |
| padding-left: 0.5em; |
| border-left: 3px solid #dddddd; |
| } |
| |
| div.exampleblock > div.content { |
| border-left: 3px solid #dddddd; |
| padding-left: 0.5em; |
| } |
| |
| div.imageblock div.content { padding-left: 0; } |
| span.image img { border-style: none; vertical-align: text-bottom; } |
| a.image:visited { color: white; } |
| |
| dl { |
| margin-top: 0.8em; |
| margin-bottom: 0.8em; |
| } |
| dt { |
| margin-top: 0.5em; |
| margin-bottom: 0; |
| font-style: normal; |
| color: navy; |
| } |
| dd > *:first-child { |
| margin-top: 0.1em; |
| } |
| |
| ul, ol { |
| list-style-position: outside; |
| } |
| ol.arabic { |
| list-style-type: decimal; |
| } |
| ol.loweralpha { |
| list-style-type: lower-alpha; |
| } |
| ol.upperalpha { |
| list-style-type: upper-alpha; |
| } |
| ol.lowerroman { |
| list-style-type: lower-roman; |
| } |
| ol.upperroman { |
| list-style-type: upper-roman; |
| } |
| |
| div.compact ul, div.compact ol, |
| div.compact p, div.compact p, |
| div.compact div, div.compact div { |
| margin-top: 0.1em; |
| margin-bottom: 0.1em; |
| } |
| |
| tfoot { |
| font-weight: bold; |
| } |
| td > div.verse { |
| white-space: pre; |
| } |
| |
| div.hdlist { |
| margin-top: 0.8em; |
| margin-bottom: 0.8em; |
| } |
| div.hdlist tr { |
| padding-bottom: 15px; |
| } |
| dt.hdlist1.strong, td.hdlist1.strong { |
| font-weight: bold; |
| } |
| td.hdlist1 { |
| vertical-align: top; |
| font-style: normal; |
| padding-right: 0.8em; |
| color: navy; |
| } |
| td.hdlist2 { |
| vertical-align: top; |
| } |
| div.hdlist.compact tr { |
| margin: 0; |
| padding-bottom: 0; |
| } |
| |
| .comment { |
| background: yellow; |
| } |
| |
| .footnote, .footnoteref { |
| font-size: 0.8em; |
| } |
| |
| span.footnote, span.footnoteref { |
| vertical-align: super; |
| } |
| |
| #footnotes { |
| margin: 20px 0 20px 0; |
| padding: 7px 0 0 0; |
| } |
| |
| #footnotes div.footnote { |
| margin: 0 0 5px 0; |
| } |
| |
| #footnotes hr { |
| border: none; |
| border-top: 1px solid silver; |
| height: 1px; |
| text-align: left; |
| margin-left: 0; |
| width: 20%; |
| min-width: 100px; |
| } |
| |
| div.colist td { |
| padding-right: 0.5em; |
| padding-bottom: 0.3em; |
| vertical-align: top; |
| } |
| div.colist td img { |
| margin-top: 0.3em; |
| } |
| |
| @media print { |
| #footer-badges { display: none; } |
| } |
| |
| #toc { |
| margin-bottom: 2.5em; |
| } |
| |
| #toctitle { |
| color: #527bbd; |
| font-size: 1.1em; |
| font-weight: bold; |
| margin-top: 1.0em; |
| margin-bottom: 0.1em; |
| } |
| |
| div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
| margin-top: 0; |
| margin-bottom: 0; |
| } |
| div.toclevel2 { |
| margin-left: 2em; |
| font-size: 0.9em; |
| } |
| div.toclevel3 { |
| margin-left: 4em; |
| font-size: 0.9em; |
| } |
| div.toclevel4 { |
| margin-left: 6em; |
| font-size: 0.9em; |
| } |
| |
| span.aqua { color: aqua; } |
| span.black { color: black; } |
| span.blue { color: blue; } |
| span.fuchsia { color: fuchsia; } |
| span.gray { color: gray; } |
| span.green { color: green; } |
| span.lime { color: lime; } |
| span.maroon { color: maroon; } |
| span.navy { color: navy; } |
| span.olive { color: olive; } |
| span.purple { color: purple; } |
| span.red { color: red; } |
| span.silver { color: silver; } |
| span.teal { color: teal; } |
| span.white { color: white; } |
| span.yellow { color: yellow; } |
| |
| span.aqua-background { background: aqua; } |
| span.black-background { background: black; } |
| span.blue-background { background: blue; } |
| span.fuchsia-background { background: fuchsia; } |
| span.gray-background { background: gray; } |
| span.green-background { background: green; } |
| span.lime-background { background: lime; } |
| span.maroon-background { background: maroon; } |
| span.navy-background { background: navy; } |
| span.olive-background { background: olive; } |
| span.purple-background { background: purple; } |
| span.red-background { background: red; } |
| span.silver-background { background: silver; } |
| span.teal-background { background: teal; } |
| span.white-background { background: white; } |
| span.yellow-background { background: yellow; } |
| |
| span.big { font-size: 2em; } |
| span.small { font-size: 0.6em; } |
| |
| span.underline { text-decoration: underline; } |
| span.overline { text-decoration: overline; } |
| span.line-through { text-decoration: line-through; } |
| |
| div.unbreakable { page-break-inside: avoid; } |
| |
| |
| /* |
| * xhtml11 specific |
| * |
| * */ |
| |
| div.tableblock { |
| margin-top: 1.0em; |
| margin-bottom: 1.5em; |
| } |
| div.tableblock > table { |
| border: 3px solid #527bbd; |
| } |
| thead, p.table.header { |
| font-weight: bold; |
| color: #527bbd; |
| } |
| p.table { |
| margin-top: 0; |
| } |
| /* Because the table frame attribute is overriden by CSS in most browsers. */ |
| div.tableblock > table[frame="void"] { |
| border-style: none; |
| } |
| div.tableblock > table[frame="hsides"] { |
| border-left-style: none; |
| border-right-style: none; |
| } |
| div.tableblock > table[frame="vsides"] { |
| border-top-style: none; |
| border-bottom-style: none; |
| } |
| |
| |
| /* |
| * html5 specific |
| * |
| * */ |
| |
| table.tableblock { |
| margin-top: 1.0em; |
| margin-bottom: 1.5em; |
| } |
| thead, p.tableblock.header { |
| font-weight: bold; |
| color: #527bbd; |
| } |
| p.tableblock { |
| margin-top: 0; |
| } |
| table.tableblock { |
| border-width: 3px; |
| border-spacing: 0px; |
| border-style: solid; |
| border-color: #527bbd; |
| border-collapse: collapse; |
| } |
| th.tableblock, td.tableblock { |
| border-width: 1px; |
| padding: 4px; |
| border-style: solid; |
| border-color: #527bbd; |
| } |
| |
| table.tableblock.frame-topbot { |
| border-left-style: hidden; |
| border-right-style: hidden; |
| } |
| table.tableblock.frame-sides { |
| border-top-style: hidden; |
| border-bottom-style: hidden; |
| } |
| table.tableblock.frame-none { |
| border-style: hidden; |
| } |
| |
| th.tableblock.halign-left, td.tableblock.halign-left { |
| text-align: left; |
| } |
| th.tableblock.halign-center, td.tableblock.halign-center { |
| text-align: center; |
| } |
| th.tableblock.halign-right, td.tableblock.halign-right { |
| text-align: right; |
| } |
| |
| th.tableblock.valign-top, td.tableblock.valign-top { |
| vertical-align: top; |
| } |
| th.tableblock.valign-middle, td.tableblock.valign-middle { |
| vertical-align: middle; |
| } |
| th.tableblock.valign-bottom, td.tableblock.valign-bottom { |
| vertical-align: bottom; |
| } |
| |
| |
| /* |
| * manpage specific |
| * |
| * */ |
| |
| body.manpage h1 { |
| padding-top: 0.5em; |
| padding-bottom: 0.5em; |
| border-top: 2px solid silver; |
| border-bottom: 2px solid silver; |
| } |
| body.manpage h2 { |
| border-style: none; |
| } |
| body.manpage div.sectionbody { |
| margin-left: 3em; |
| } |
| |
| @media print { |
| body.manpage div#toc { display: none; } |
| } |
| |
| |
| </style> |
| <script type="text/javascript"> |
| /*<+'])'); |
| // Function that scans the DOM tree for header elements (the DOM2 |
| // nodeIterator API would be a better technique but not supported by all |
| // browsers). |
| var iterate = function (el) { |
| for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { |
| var mo = re.exec(i.tagName); |
| if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { |
| result[result.length] = new TocEntry(i, getText(i), mo[1]-1); |
| } |
| iterate(i); |
| } |
| } |
| } |
| iterate(el); |
| return result; |
| } |
| |
| var toc = document.getElementById("toc"); |
| if (!toc) { |
| return; |
| } |
| |
| // Delete existing TOC entries in case we're reloading the TOC. |
| var tocEntriesToRemove = []; |
| var i; |
| for (i = 0; i < toc.childNodes.length; i++) { |
| var entry = toc.childNodes[i]; |
| if (entry.nodeName.toLowerCase() == 'div' |
| && entry.getAttribute("class") |
| && entry.getAttribute("class").match(/^toclevel/)) |
| tocEntriesToRemove.push(entry); |
| } |
| for (i = 0; i < tocEntriesToRemove.length; i++) { |
| toc.removeChild(tocEntriesToRemove[i]); |
| } |
| |
| // Rebuild TOC entries. |
| var entries = tocEntries(document.getElementById("content"), toclevels); |
| for (var i = 0; i < entries.length; ++i) { |
| var entry = entries[i]; |
| if (entry.element.id == "") |
| entry.element.id = "_toc_" + i; |
| var a = document.createElement("a"); |
| a.href = "#" + entry.element.id; |
| a.appendChild(document.createTextNode(entry.text)); |
| var div = document.createElement("div"); |
| div.appendChild(a); |
| div.className = "toclevel" + entry.toclevel; |
| toc.appendChild(div); |
| } |
| if (entries.length == 0) |
| toc.parentNode.removeChild(toc); |
| }, |
| |
| |
| ///////////////////////////////////////////////////////////////////// |
| // Footnotes generator |
| ///////////////////////////////////////////////////////////////////// |
| |
| /* Based on footnote generation code from: |
| * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html |
| */ |
| |
| footnotes: function () { |
| // Delete existing footnote entries in case we're reloading the footnodes. |
| var i; |
| var noteholder = document.getElementById("footnotes"); |
| if (!noteholder) { |
| return; |
| } |
| var entriesToRemove = []; |
| for (i = 0; i < noteholder.childNodes.length; i++) { |
| var entry = noteholder.childNodes[i]; |
| if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") |
| entriesToRemove.push(entry); |
| } |
| for (i = 0; i < entriesToRemove.length; i++) { |
| noteholder.removeChild(entriesToRemove[i]); |
| } |
| |
| // Rebuild footnote entries. |
| var cont = document.getElementById("content"); |
| var spans = cont.getElementsByTagName("span"); |
| var refs = {}; |
| var n = 0; |
| for (i=0; i<spans.length; i++) { |
| if (spans[i].className == "footnote") { |
| n++; |
| var note = spans[i].getAttribute("data-note"); |
| if (!note) { |
| // Use [\s\S] in place of . so multi-line matches work. |
| // Because JavaScript has no s (dotall) regex flag. |
| note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; |
| spans[i].innerHTML = |
| "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| spans[i].setAttribute("data-note", note); |
| } |
| noteholder.innerHTML += |
| "<div class='footnote' id='_footnote_" + n + "'>" + |
| "<a href='#_footnoteref_" + n + "' title='Return to text'>" + |
| n + "</a>. " + note + "</div>"; |
| var id =spans[i].getAttribute("id"); |
| if (id != null) refs["#"+id] = n; |
| } |
| } |
| if (n == 0) |
| noteholder.parentNode.removeChild(noteholder); |
| else { |
| // Process footnoterefs. |
| for (i=0; i<spans.length; i++) { |
| if (spans[i].className == "footnoteref") { |
| var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); |
| href = href.match(/#.*/)[0]; // Because IE return full URL. |
| n = refs[href]; |
| spans[i].innerHTML = |
| "[<a href='#_footnote_" + n + |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| } |
| } |
| } |
| }, |
| |
| install: function(toclevels) { |
| var timerId; |
| |
| function reinstall() { |
| asciidoc.footnotes(); |
| if (toclevels) { |
| asciidoc.toc(toclevels); |
| } |
| } |
| |
| function reinstallAndRemoveTimer() { |
| clearInterval(timerId); |
| reinstall(); |
| } |
| |
| timerId = setInterval(reinstall, 500); |
| if (document.addEventListener) |
| document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); |
| else |
| window.onload = reinstallAndRemoveTimer; |
| } |
| |
| } |
| asciidoc.install(); |
| /*]]>*/ |
| </script> |
| </head> |
| <body class="article"> |
| <div id="header"> |
| <h1>Freedoom</h1> |
| </div> |
| <div id="content"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"><p>Freedoom is a project to create a complete Doom II-compatible IWAD file |
| which is Free Software.</p></div> |
| <div class="paragraph"><p>The IWAD file is the file used by Doom which contains all the game data |
| (graphics, sound effects, music, etc.). While the Doom source code is |
| Free, you currently still need one of the proprietary IWAD files from id |
| in order to play Doom. Freedoom aims to create a Free alternative. |
| Combined with the GPL-licensed Doom source code this will result in a |
| complete Free Doom-based game.</p></div> |
| <div class="paragraph"><p>For more information, see <a href="http://freedoom.github.io/">http://freedoom.github.io/</a>.</p></div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_what_8220_free_software_8221_means">What “Free Software” means</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"><p>When we speak of Free Software, we refer to the software movement in |
| which your freedoms to use, copy, modify, and study it are ensured. For |
| example, you may freely use Freedoom for any purpose you see fit, you |
| may redistribute it to anyone without needing to ask for permission, you |
| may modify it (provided you keep the license intact, see <code>COPYING</code>), and |
| you may study it — for example, to see how a Doom IWAD is built. To |
| facilitate this, you can get the full source code (here, in the form of |
| a DeuTex tree) for Freedoom.</p></div> |
| <div class="paragraph"><p>You may read more about Free Software at the <a href="http://www.gnu.org/">GNU</a> |
| and <a href="http://www.fsf.org/">Free Software Foundation</a> websites.</p></div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_contributing_to_freedoom">Contributing to Freedoom</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"><p>Contributions to Freedoom are always welcome, however there are a few |
| guidelines that should be followed:</p></div> |
| <div class="sect2"> |
| <h3 id="_intellectual_property">Intellectual Property</h3> |
| <div class="paragraph"><p>We know people hate legalese, but this is important. This applies to |
| <strong>everything</strong> which is submitted.</p></div> |
| <div class="paragraph"><p>You must be incredibly careful when basing on existing graphics or |
| sounds. Most Doom projects are incredibly lax on reusing intellectual |
| property — there are plenty of WADs out there which contain modified |
| Doom sprites, for example. However, due to the nature of this project, |
| we do not have the same liberty to rip as we please.</p></div> |
| <div class="paragraph"><p>The general rules go as follows:</p></div> |
| <div class="ulist"><ul> |
| <li> |
| <p> |
| Everything you submit must be 100% your own work. You must not base |
| upon resources from Doom or any other game. You may not even rip |
| textures from WADs you have downloaded (if you find a WAD with |
| textures in which look useful, let us know — that way, we can |
| contact the author). |
| </p> |
| </li> |
| <li> |
| <p> |
| Do not simply copy the original resources. Where possible, try to |
| make an effort to make the new versions look visibly different from |
| the originals. |
| </p> |
| </li> |
| <li> |
| <p> |
| Be especially careful of “free texture” (or “free sound” or |
| “free graphic”) sites. Although these would appear at first to |
| be 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 on GNU/Linux CDs |
| (which are sold — “a commercial use”). |
| </p> |
| </li> |
| <li> |
| <p> |
| The main exception is that you may of course reuse anything in the |
| Freedoom source tree. In fact, this is encouraged, as reusing |
| material will give the WAD a more consistent feel. |
| </p> |
| </li> |
| </ul></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_levels">Levels</h3> |
| <div class="paragraph"><p>Levels should be in Boom format; you may exceed the limits of Vanilla |
| Doom and use Boom features; however, do not use features that are not |
| supported by Boom 2.02 and compatible ports. Levels should be in Doom’s |
| original format, not in “Hexen” format.</p></div> |
| <div class="paragraph"><p>It is sensible to also heed the following guidelines:</p></div> |
| <div class="ulist"><ul> |
| <li> |
| <p> |
| Make sure that skill levels are implemented, and that all |
| multiplayer start points are present. |
| </p> |
| </li> |
| <li> |
| <p> |
| Make levels appropriately difficult for their position within the |
| progression of the game. Also bear in mind that not all players may |
| be as skilled a player as you. |
| </p> |
| </li> |
| <li> |
| <p> |
| Do not use tricks that exploit Doom’s software renderer; some source |
| ports, especially those that use hardware accelerated rendering, may |
| not render it properly. Examples of tricks to avoid include those used |
| to simulate 3D bridges and “deep water” effects. |
| </p> |
| </li> |
| <li> |
| <p> |
| Boom removes almost all of the limits on rendering; however, do not |
| make excessively complicated scenes. It is desirable that Freedoom |
| levels should be playable on old or low-powered hardware. |
| </p> |
| </li> |
| <li> |
| <p> |
| Always test in <a href="http://www.teamtnt.com/boompubl/boom2.htm">Boom</a> |
| itself rather than a derivative such as PrBoom. This ensures that |
| your levels really are Boom-compatible rather than using any extra |
| features. As DOS is rather rare these days, you may not have a |
| system which can run Boom natively, so you may use either |
| <a href="http://www.dosbox.com/">DOSBox</a> or <a href="http://www.freedos.org/">FreeDOS</a>. |
| </p> |
| </li> |
| </ul></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_graphics">Graphics</h3> |
| <div class="ulist"><ul> |
| <li> |
| <p> |
| Graphics should be the same color and size as the originals to |
| remain compatible with PWADs (otherwise, they may end up looking |
| like a mess). They cannot use the Doom font. |
| </p> |
| </li> |
| <li> |
| <p> |
| Textures should be the same dimensions as the originals. They |
| should be similar but not identical (to avoid IP infringement) —  in fact, they should be as different as possible while keeping to |
| the general theme of the texture. As mentioned above, try to make |
| a conscious effort to make the textures visibly different from the |
| originals. Critically, the textures should tile in the same way as |
| the originals. |
| </p> |
| </li> |
| <li> |
| <p> |
| Some textures contain the letters UAC or references to UAC; this is |
| an intellectual property of id Software (trademarked). Instead, use |
| the letters AGM in your textures. |
| </p> |
| </li> |
| <li> |
| <p> |
| Sprites should be roughly the same size and shape, but different to |
| the originals. Doom monsters are id’s intellectual property (which |
| means no imps, cyberdemons, etc). The new monsters will behave the |
| same way as the originals, but will be totally new. |
| </p> |
| </li> |
| </ul></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_documentation">Documentation</h3> |
| <div class="paragraph"><p>Freedoom always needs help with the documentation, so please send your |
| patches, but keep in mind:</p></div> |
| <div class="ulist"><ul> |
| <li> |
| <p> |
| We use <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a> for writing the |
| documentation. AsciiDoc is a simple plaintext-based format which is |
| simple to read and write in its source form, and makes pretty HTML |
| documents out of them (it also supports other formats like |
| DocBook/PDF/manual pages…). |
| </p> |
| </li> |
| <li> |
| <p> |
| Headers are formated in a wiki-style format, this makes it easier |
| for Vim (perhaps other editors, too) to automatically re-format |
| text. |
| </p> |
| </li> |
| <li> |
| <p> |
| Text is kept at 72 characters wide. In Vim, you can set the editor |
| to automatically insert line breaks as you’re typing by performing |
| <code>set textwidth=72</code>. Special exceptions to the width rule might be |
| allowed when necessary (for example, inserting long URLs). |
| </p> |
| </li> |
| </ul></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_submitting_your_work">Submitting your work</h3> |
| <div class="paragraph"><p>TODO: Figure out the best method of doing this. This mainly requires |
| time to see what works best.</p></div> |
| <div class="paragraph"><p>If you use git, make sure your commit messages start with a single |
| line, under 72 characters, which provides an adequate summary of your |
| changes. You should prefix this line with the component you are commit |
| (for example, “map17: fixed unbeatable map”). This should be |
| followed by a blank line and more explanation if it’s needed (for |
| example, explaining what part of the map was broken). The commit |
| 2013-12-20T16:06:55Z!<a href="mailto:rjy@users.sourceforge.net">rjy@users.sourceforge.net</a> shows a good example of |
| a well-structured commit message.</p></div> |
| <div class="paragraph"><p>You should commit often; each important change should get its own |
| commit, but minor changes need not. Take advantage of git’s ability to |
| rewrite history, don’t use <code>git revert</code> on your private copy of the |
| repository, just remove (<code>git reset</code>) or amend (<code>git commit --amend</code>) |
| the faulty commit as necessary. Leave all the interesting and important |
| history bits, leave out stupid mistakes like spell check errors.</p></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footnotes"><hr /></div> |
| <div id="footer"> |
| <div id="footer-text"> |
| Last updated 2014-01-01 14:49:16 PST |
| </div> |
| </div> |
| </body> |
| </html> |