README.md

This is the official TFA SWEP Base documentation.

Before going through anything from here, make sure you have read through Lua basics guide for GMod here first!

List of contents:

• Frequently Asked Questions - Answers to common base users questions
• Weapon Template - reference for the main weapon Lua file with all values (legacy template is available for backwards compatibility reference)
• Melee Weapon Template - reference for melee-type weapons
• Attachment Template - file name is the ID of attachment that goes into SWEP.Attachments table, place to <your addon>/lua/tfa/att folder
• Animations Reference - list of animations that are used by the base
• Custom Hooks - list of hooks added by the base for the addons intercompatibility
• Developer FAQ - Common code stuff relevant to developing TFA Base addons

Paths that are loaded by the base automatically (in load order):

• lua/tfa/enums/ - Early enums initialization (only recommended for early global variables declaration)
• lua/tfa/modules/ - Base modules (official modules are loaded first; custom modules loading is only kept for backwards compatibility and is unsupported!)
• lua/tfa/external/ - External modules (code loaded in there is guaranteed to have TFA global variable initalized)
• lua/tfa/att/ - Attachments (files with base in their name are loaded first)

All paths (except attachments) support client and server-side separation by prepending cl_ or sv_ to the file name.

For any questions regarding this documentation or any problems with developing addons for TFA Base, post in #development-help channel of the official support Discord server.

If you want to translate the base to your language, take a look at the localization reference!