etlegacy-docs/index.rst
Aranud dafe70f767
Hud editor (#8)
Co-authored-by: Helldembez <helldembez@protonmail.com>
2023-04-13 17:38:22 +02:00

33 lines
2 KiB
ReStructuredText

.. ET: Legacy documentation documentation master file, created by
sphinx-quickstart on Wed Mar 18 17:05:46 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
ET: Legacy
==========
Welcome to the ET: Legacy's documentation!
`ET: Legacy <http://www.etlegacy.com>`_ is an open source project based on the code of `Wolfenstein: Enemy Territory <https://www.splashdamage.com/games/wolfenstein-enemy-territory/>`_ which `was released <https://www.splashdamage.com/news/wolfenstein-enemy-territory-goes-open-source/>`_ in 2010 under the terms of the `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_.
Set during World War II and heavily focused on team work, the game was initially released in 2003 by Splash Damage and id Software. More than a decade after its release, after spending countless hours of escorting tanks and trucks, stealing gold and radar parts and transmitting confidential documents, it was time to dust off the game which consistently refused to go down.
There are two aspects to this project:
* An updated game engine, **ET: Legacy**, which aims to fix bugs and security exploits, remove old dependencies, add useful features and modernize its graphics while still remaining compatible with ET 2.60b and as many of its mods as possible.
* A new mod, **Legacy**, which aims to add many useful features and improvements while staying close to the original gameplay, as well as being lightweight and extensible through Lua scripts.
.. important:: This documentation aims to be a centralized reference only. For information about common issues, getting help or contributing to the project, ensure to visit the official `website <https://www.etlegacy.com>`_ and `wiki <https://github.com/etlegacy/etlegacy/wiki>`_.
.. note:: For scripting customization of Legacy mod, check the `Lua API reference <https://etlegacy-lua-docs.readthedocs.io/>`_.
.. toctree::
:maxdepth: 2
manual
cvars
commands
vsays
resources
skillrating
hudeditor