6ee870b85a9d05f803baa9145da23c39c2b9ada7
[xonotic/xonotic.wiki.git] / BaI-mod.md
1 > ## Table of Contents
2 > 1. [Notes for developers](#notes-for-developers)
3 > 2. [HUD configuration](#hud-configuration)
4 > 3. [Chat sounds](#chat-sounds)
5 > 4. [References](#references)
6
7
8 [**Mod**](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server) developed by [**z411**](https://gitlab.com/z411) for the BaI Xonotic server. Most of these are features ported from Quake 3/Quake Live and some might be undesirable for some Xonotic players, here is the content in case Xonotic players want any of them in the main game.
9
10
11 # Notes for developers
12
13 ### Mod resources
14
15 Note: PATH is one of the following depending on your system
16
17 |OS|Path|
18 |:--|:--|
19 |Windows|C:\Users\yourusername\Saved Games\xonotic|
20 |Linux|~/.xonotic|
21 |Mac|~/Library/Application Support/xonotic|
22 Nothing should *ever* be added to the main installation folder of Xonotic, use these paths!
23
24 The resources should be saved in `PATH/data`.
25
26 - Announcer (execute `cl_announcer shobon` command to activate the resource):
27
28 [zzz-bai-announcer-v9.pk3](uploads/bc6f4532a636aae501c8a800ceed0eb2/zzz-bai-announcer-v9.pk3)
29
30 - Icons of country flags, medals and scoreboard logo:
31
32 [zzz-bai-gfx-v8.pk3](uploads/c9dd058351dd79b05014293df321836d/zzz-bai-gfx-v8.pk3)
33
34 - Soundtrack of when a match is over and the players are in pause voting to select gamemodes/maps:
35
36 [zzz-bai-jingle-v1.pk3](uploads/8a541fbdf6d2ab0447567eb1e18d3e13/zzz-bai-jingle-v1.pk3)
37
38 - Chat sounds:
39
40 [zzz-bai-jokes-v18.pk3](uploads/f16e2c669c122f62d8ae663f4df18823/zzz-bai-jokes-v18.pk3)
41
42 - Quickmenu:
43
44 [zzz-bai-quickmenu-v2.pk3](uploads/7607735ad75ec0853a3f88a3ecf018ae/zzz-bai-quickmenu-v2.pk3)
45
46 - Set of sound effects about when player shots, a flag is fallen, ...
47
48 [zzz-bai-sounds-v11.pk3](uploads/247dc57e177a7d08c2b7ce7e42cd3995/zzz-bai-sounds-v11.pk3)
49
50 ### Source code
51
52 The code is in z411's branch: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server
53
54 LegendGuard has forked the mod and added some stuff in this branch: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/LegendaryGuard/bai_mod
55
56 Remember look the [**repository guide**](https://gitlab.com/xonotic/xonotic/-/wikis/Repository_Access) to use this code.
57
58 #### List of source code files where mod was developed
59
60 Client base:
61
62 - [`qcsrc/server/client.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/server/client.qc)
63
64 Scoreboard:
65
66 - [`qcsrc/client/hud/panel/scoreboard.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/scoreboard.qc)
67
68 - [`qcsrc/common/scores.qh`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/common/scores.qh)
69
70 Chat:
71
72 - [`qcsrc/client/hud/panel/chat.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/chat.qc)
73
74 Spectator HUD:
75
76 - [`qcsrc/client/hud/panel/spect.qh`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/spect.qh)
77
78 - [`qcsrc/client/hud/panel/spect.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/spect.qc)
79
80 Attacker text:
81
82 - All files inside this folder:
83 [`qcsrc/common/mutators/mutator/attackertext/`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server/qcsrc/common/mutators/mutator/attackertext)
84
85
86 # HUD configuration
87
88 Cvars: 
89
90 `hud_spectatorteamdisplay 1 //sets team spectator display HUD`
91
92 `hud_spectatorplayernamedisplay 1 //sets player name spectator display HUD`
93
94 <img src="uploads/2dc395d83ac793aa20f502a1bfd5bb12/SpectatorHUD.jpg" alt="SpectatorHUD" width="500"/>
95
96
97 `cl_attackertext 1 //sets attacker text to know who is attacking`
98
99 <img src="uploads/19d0104a69a9bf92aa0b65c111ab0488/attackername.jpg" alt="attackername" width="200"/>
100
101
102 `hud_itempickupdisplay 1 //sets item pickup display HUD`
103
104 <img src="uploads/3d3d116722312d471408c7d178595e6d/items.jpg" alt="items" width="200"/>
105
106 # Chat sounds
107
108 To activate chat sounds, you can add sounds as you want:
109 You should put the sounds inside a .pk3 in the path `sound/chat/sound_name.ogg`
110 For example:
111 ```
112 sound/chat/sound1.ogg
113 sound/chat/sound2.ogg
114 sound/chat/sound3.ogg
115 ```
116 Then you should set the following cvars in your server config:
117 ```
118 set sv_chat_sounds 1
119 set sv_chat_sounds_list "sound1 sound2 sound3"
120 ```
121 The cvar `cl_chat_sounds` is only on the client side in case you're on a server with sounds and these bother you, you can disable them from your side only.
122
123 BaI server uses the following chat sounds configuration (chat sounds pk3 resource is needed to use these sounds):
124 ```
125 cmd sounds //to check chat sound list
126 set sv_chat_sounds 1
127 set sv_chat_sounds_list "200 abusadores alert andate antabaka apruebo arigato au avispate aweonao batman bonk bork brigido bruh buitre callese chan chaojefe chimp choro choro2 choro3 combobreaker cristian ctm ctm2 ctm3 cyka daleboludo drop drop2 economia eliminado enfermedad fama felipe fumando1 fumando2 gallina garrotera gas gay gracias hitler homero israel jiji july3p lacra laputaquemepario larva lepego macaco matias mefunaron meopene meperdonas mequierematar mevoy mipixula mira mybody nana nice noloserick nopuedeser notengoidea nya ooh pablo pancito pencaql picasso picasso2 piropo probando problema que quepaso rage1 rage2 rage3 rata ratero risas roblox runbitch salee salee2 scream simp suck sugoi suspension talisto tarde tepillamos tin tom tontown tranquilo tuturu urss uuh uuy vetealamierda viejaculia watashi waton wena weonculiao willy windows winning xq yabai yabasta yamete yawey yoo"
128 ```
129
130 You can write in the chat, the sound name to be played.
131
132 # References
133
134 https://omaera.org/~z411/xonotic/