Skip to content

Commit d55ac04

Browse files
committed
Improve documentation for generic weapons
1 parent 0f43702 commit d55ac04

File tree

6 files changed

+49
-0
lines changed

6 files changed

+49
-0
lines changed

documentation/content/docs/development/getting-started.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ sporelauncher
5353
shockrifle
5454
penguin
5555
uzi
56+
57+
pistol
58+
pistol2
59+
smg
60+
smg2
61+
rifle
62+
rifle2
63+
shotgun2
64+
sniperrifle2
5665
```
5766
{{% /details %}}
5867

documentation/content/docs/entity-guide/entities/weapon_pistol.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ entityCategory: pickup
99
Generic weapon meant to be configured via [Weapon templates]({{< ref weapon-templates >}}).
1010

1111
By default it uses the same model and primary attack as [weapon_9mmhandgun]({{< ref weapon_9mmhandgun >}}).
12+
13+
{{% hint info %}}
14+
Don't forget to include **sprites/weapon_pistol.txt** in your mod files.
15+
16+
Also enable `pistol` in **features/featureful_weapons.cfg**.
17+
18+
Configure the weapon HUD position via **features/hud_weapon_layout.cfg**.
19+
{{% /hint %}}

documentation/content/docs/entity-guide/entities/weapon_rifle.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,11 @@ entityCategory: pickup
77
# weapon_rifle
88

99
Same as [weapon_smg]({{< ref weapon_smg >}}) but uses a different classname, so it's a different weapon.
10+
11+
{{% hint info %}}
12+
Don't forget to include **sprites/weapon_rifle.txt** in your mod files.
13+
14+
Also enable `rifle` in **features/featureful_weapons.cfg**.
15+
16+
Configure the weapon HUD position via **features/hud_weapon_layout.cfg**.
17+
{{% /hint %}}

documentation/content/docs/entity-guide/entities/weapon_shotgun2.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ entityCategory: pickup
99
Generic weapon meant to be configured via [Weapon templates]({{< ref weapon-templates >}}).
1010

1111
By default it uses the same model and primary attack as [weapon_shotgun]({{< ref weapon_shotgun >}}).
12+
13+
{{% hint info %}}
14+
Don't forget to include **sprites/weapon_shotgun2.txt** in your mod files.
15+
16+
Also enable `shotgun2` in **features/featureful_weapons.cfg**.
17+
18+
Configure the weapon HUD position via **features/hud_weapon_layout.cfg**.
19+
{{% /hint %}}

documentation/content/docs/entity-guide/entities/weapon_smg.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ entityCategory: pickup
99
Generic weapon meant to be configured via [Weapon templates]({{< ref weapon-templates >}}).
1010

1111
By default it uses the same model and primary attack as [weapon_9mmAR]({{< ref weapon_9mmAR >}}).
12+
13+
{{% hint info %}}
14+
Don't forget to include **sprites/weapon_smg.txt** in your mod files.
15+
16+
Also enable `smg` in **features/featureful_weapons.cfg**.
17+
18+
Configure the weapon HUD position via **features/hud_weapon_layout.cfg**.
19+
{{% /hint %}}

documentation/content/docs/entity-guide/entities/weapon_sniperrifle2.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ entityCategory: pickup
99
Generic weapon meant to be configured via [Weapon templates]({{< ref weapon-templates >}}).
1010

1111
By default it uses the same model, primary attack and secondary attack as [weapon_sniperrifle]({{< ref weapon_sniperrifle >}}).
12+
13+
{{% hint info %}}
14+
Don't forget to include **sprites/weapon_sniperrifl2.txt** in your mod files.
15+
16+
Also enable `sniperrifle2` in **features/featureful_weapons.cfg**.
17+
18+
Configure the weapon HUD position via **features/hud_weapon_layout.cfg**.
19+
{{% /hint %}}

0 commit comments

Comments
 (0)