tfscript/docs/source/index.rst

34 lines
1.7 KiB
ReStructuredText
Raw Permalink Normal View History

2022-08-09 18:48:18 -04:00
Welcome to TFScript
====================================
TFScript helps you manage all the customisations you make to your Team Fortress 2 configurations. If you have `custom scripts <https://wiki.teamfortress.com/wiki/Scripting_faq>`_ in your ``cfg`` files, then this will help you automate that.
TFScript uses YAML to express how you want your keybindings to work. It helps you organize your bindings. It lets you put all the keybindings for all your classes into a single file. It lets you set some basic defaults that then get copied into every class so you can count on them all the time. Once you've got a good YAML file describing your favorite keybindings, you can manage all your bindings from that single file.
2022-08-13 16:50:40 -04:00
Basic overview
====================================
TFScript is meant to simplify the complexity of creating tf2 keybinds. While simple binds may be easy, more complex actions such as key combinations and toggles can be quite complex.
The basic process for creating a TFScript config file goes as such:
1. Write your TFScript file according to the :ref:`syntax-page` guide
2022-08-13 16:50:40 -04:00
2. Run ``TFScript <filename>`` to generate code and write to game files
3. Play tf2 with your new binds!
A TFScript file is written in YAML and parsed by the program to generate the apporpriate code, so if you know the YAML you can jump straight to the :ref:`syntax-page` page, otherwise, read the :ref:`yaml-page` page first, *then* read the :ref:`syntax-page` page.
2022-08-13 16:50:40 -04:00
Known issues, problems, etc.
=================================
none everything is perfect and there are no problems it is all amazing
2022-08-09 18:48:18 -04:00
.. toctree::
2022-08-09 19:55:04 -04:00
:hidden:
:glob:
2022-08-13 16:50:40 -04:00
*
.. meta::
:description: TFScript scripting tool for Team Fortress 2
:keywords: Team Fortress, TF2, tf2 script