etlegacy/etlegacy-assets
0
0
Fork 0
mirror of https://github.com/etlegacy/etlegacy-assets.git synced 2024-11-21 11:31:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update asset-documentation.rst

Browse source
This commit is contained in:
mightykemon 2018-04-25 14:21:39 +02:00 committed by GitHub
parent 9e2c904573
commit 624c1f9f45
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
asset-documentation.rst
View file

@ -8,6 +8,55 @@ Asset Documentation
===================
--------
Foreword
--------
Welcome to ET: Legacy's Asset Documentation!
The original assets included in pak0, pak1 and pak2 unfortunately weren't included in the `source release <https://github.com/id-Software/Enemy-Territory>`_. For `ET: Legacy <http://www.etlegacy.com>`_ to ever become independent of these paks, there is the need of creating replacements. To keep a proper overview of the process, this documentation includes a full list of all original assets, their state of replacements as well as Legacy-only assets.
Status
======
Displays the status of the asset in Legacy.
* **"obsolete"**: Deprecated assets from the original game that have been removed in Legacy.
* **"missing"**: Assets from the original game that still need to be replaced in Legacy.
* **"done"**: Assets that have been replaced already and are in a satisfactory state.
* **"alpha"**: Assets that have been included as placeholders. To be improved at a later date.
* **"beta"**: Assets that have been improved, but are likely still subject to change.
Author
======
List of all people involved in the creation of the respective asset for possible future questions.
Sorted alphabetically and limited to 12 chars.
Resources
=========
List of all used resources to avoid any license issues.
Origin
======
The origin of an asset is intended to show where it comes from and why it is part of Legacy.
* **"pak0"**, **"pak1"**, **"pak2"**: Assets from the original game that had to be replaced for license purposes.
* **"shader"**: Assets that were specified in shader files in the original game, but had no actual appearance. Rather than removing the shader files, to avoid compatibility issues, the missing assets have been restored.
* **"[MAP_NAME]"**: Assets that are used in a custom map shipped with Legacy.
* **"ETL"**: Assets created exclusively for Legacy for various purposes.
* **"RtCW"**: Due to the similar style, various RtCW assets might be reconstructed and included in Legacy to provide a larger pool for mappers, modders, etc.
-------------
Documentation
-------------
animations