-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathindex.html
52 lines (52 loc) · 2.69 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
---
layout: default
title: fopdoc
---
<p>The Oblivion, Skyrim, Fallout 3 and Fallout: New Vegas plugin file formats are all very similar, but while there
exists good documentation for <a href="http://en.uesp.net/wiki/Tes4Mod:Mod_File_Format">Oblivion</a>, there is no equivalent for Fallout 3 and Fallout: New Vegas. The aim is for this repository to become that equivalent.
</p>
<p>See <a href="{{site.baseurl}}/CONTRIBUTING.html">Contributing</a> for information on how to contribute.</p>
<h3>Conventions:</h3>
<p>The conventions used by this documentation are given in <a href="{{site.baseurl}}/Conventions.html">Conventions
</a>. Data structure
definitions are found in one of the following subfolders:
</p>
<p>Each record type is documented in a separate file. Subrecords that share the same structure across multiple record
types are documented in separate files, while those unique to a particular record are documented in that record's file.
</p>
<h3>Format:</h3>
<p>This documentation is written in <a
href="https://guides.github.com/overviews/mastering-markdown">GitHub Flavored Markdown</a>
and stored in a Git repository on <a href="http://tes5edit.github.io/fopdoc")>GitHub</a> because:
</p>
<ul>
<li>Revision control is good.</li>
<li>You can download the documentation for offline reading.</li>
<li>Markdown gives readable plain text and can also be readily converted to HTML.</li>
<li>GitHub offers in-browser editing and HTML preview for Markdown.</li>
<li>GitHub makes it easier to make, share and integrate edits with others.</li>
</ul>
<h3>File Format Data Source:</h3>
<p>The most complete open-source implementation of plugin parsers for these games is
<a href="https://github.com/TES5Edit/TES5Edit">TES5Edit</a>, written in Delphi. The
information on the
file formats contained within its parsing code has been adapted into a reasonably generic format that programmers
should be able to interpret regardless of their preferred language, similar to how it is presented by
<a href="http://www.uesp.net/wiki/Tes5Mod:Mod_File_Format">UESP.net</a>.
</p>
<p>This documentation was written to reflect the TES5Edit source code on 2 June 2014.</p>
<h2>Legal:</h2>
<p><a href="{{site.baseurl}}/legal.html">Legal</a></p>
<h2 id="AuthorsandContributors">Authors and Contributors</h2>
<p class="empty"> </p>
<p>The original author is <a href="https://github.com/Ortham">Ortham a.k.a. WrinklyNinja</a>. Below is a list of contributors to the fopdoc project.</p>
<p class="empty"> </p>
<ul>
{% for member in site.data.members %}
<li>
<a href="https://github.com/{{ member.github }}">
{{ member.name }}
</a>
</li>
{% endfor %}
</ul>