Upload

addons/tfa-base/README.md

@@ -0,0 +1,25 @@
+# TFA Base
+A customizable, modular, feature-rich weapon base for Garry's Mod.
+
+# How to use
+## As a user
+* Install a [workshop version](https://steamcommunity.com/sharedfiles/filedetails/?id=415143062) (stable)
+* Clone the repository into `addons` folder (unstable, no support)
+## As a developer
+* For making weapons: check out the [weapon template](lua/weapons/tfa_base_template/shared.lua)
+* For making attachments: see the [base attachment](lua/tfa/att/base.lua) for reference
+
+# Copyright stuff
+* All base code is licensed under [MIT](https://opensource.org/licenses/MIT), unless otherwise stated in the code file. The only exception to the license is [GMod's Steam Workshop Rules](https://wiki.facepunch.com/gmod/Steam_Workshop_Rules), which forbids reuploading addons in there.
+* Сustom assets (made by base contributors) is licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
+
+# Credits
+* INCONCEIVABLE — Assets for scope overlays
+* Clavus — SWEP Construction Kit code and reference
+* Wystan — Attachments models
+* 『クリスチャン』 — Nearly-empty click sounds
+* Valve — Shell casings models
+
+# Contact us
+* [Discord](https://discord.com/invite/Gxqx67n)
+* [Steam Group](https://steamcommunity.com/groups/tfa-mods)