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. [Country flags](#country-flags)
   6 > 5. [References](#references)
   7
   8
   9 [**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.
  10
  11
  12 # Notes for developers
  13
  14 ### Mod resources
  15
  16 Note: PATH is one of the following depending on your system
  17
  18 |OS|Path|
  19 |:--|:--|
  20 |Windows|C:\Users\yourusername\Saved Games\xonotic|
  21 |Linux|~/.xonotic|
  22 |Mac|~/Library/Application Support/xonotic|
  23 Nothing should *ever* be added to the main installation folder of Xonotic, use these paths!
  24
  25 The resources should be saved in `PATH/data`.
  26
  27 - Announcer (execute `cl_announcer shobon` command to activate the resource):
  28
  29 [zzz-bai-announcer-v9.pk3](uploads/bc6f4532a636aae501c8a800ceed0eb2/zzz-bai-announcer-v9.pk3)
  30
  31 - Icons of country flags, medals and scoreboard logo:
  32
  33 [zzz-bai-gfx-v8.pk3](uploads/c9dd058351dd79b05014293df321836d/zzz-bai-gfx-v8.pk3)
  34
  35 - Soundtrack of when a match is over and the players are in pause voting to select gamemodes/maps:
  36
  37 [zzz-bai-jingle-v1.pk3](uploads/8a541fbdf6d2ab0447567eb1e18d3e13/zzz-bai-jingle-v1.pk3)
  38
  39 - Chat sounds:
  40
  41 [zzz-bai-jokes-v18.pk3](uploads/f16e2c669c122f62d8ae663f4df18823/zzz-bai-jokes-v18.pk3)
  42
  43 - Quickmenu:
  44
  45 [zzz-bai-quickmenu-v2.pk3](uploads/7607735ad75ec0853a3f88a3ecf018ae/zzz-bai-quickmenu-v2.pk3)
  46
  47 - Set of sound effects about when player shots, a flag is fallen, ...
  48
  49 [zzz-bai-sounds-v11.pk3](uploads/247dc57e177a7d08c2b7ce7e42cd3995/zzz-bai-sounds-v11.pk3)
  50
  51 ### Source code
  52
  53 The code is in z411's branch: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server
  54
  55 LegendGuard has forked the mod and added some stuff in this branch: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/LegendaryGuard/bai_mod
  56
  57 Remember look the [**repository guide**](https://gitlab.com/xonotic/xonotic/-/wikis/Repository_Access) to use this code.
  58
  59 #### List of source code files where mod was developed
  60
  61 Client base:
  62
  63 - [`qcsrc/server/client.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/server/client.qc)
  64
  65 Scoreboard:
  66
  67 - [`qcsrc/client/hud/panel/scoreboard.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/scoreboard.qc)
  68
  69 - [`qcsrc/common/scores.qh`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/common/scores.qh)
  70
  71 Chat:
  72
  73 - [`qcsrc/client/hud/panel/chat.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/chat.qc)
  74
  75 Spectator HUD:
  76
  77 - [`qcsrc/client/hud/panel/spect.qh`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/spect.qh)
  78
  79 - [`qcsrc/client/hud/panel/spect.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/spect.qc)
  80
  81 Attacker text:
  82
  83 - All files inside this folder:
  84 [`qcsrc/common/mutators/mutator/attackertext/`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server/qcsrc/common/mutators/mutator/attackertext)
  85
  86
  87 # HUD configuration
  88
  89 Cvars:
  90
  91 `hud_spectatorteamdisplay 1 //sets team spectator display HUD`
  92
  93 `hud_spectatorplayernamedisplay 1 //sets player name spectator display HUD`
  94
  95 <img src="uploads/2dc395d83ac793aa20f502a1bfd5bb12/SpectatorHUD.jpg" alt="SpectatorHUD" width="500"/>
  96
  97
  98 `cl_attackertext 1 //sets attacker text to know who is attacking`
  99
 100 <img src="uploads/19d0104a69a9bf92aa0b65c111ab0488/attackername.jpg" alt="attackername" width="200"/>
 101
 102
 103 `hud_itempickupdisplay 1 //sets item pickup display HUD`
 104
 105 <img src="uploads/3d3d116722312d471408c7d178595e6d/items.jpg" alt="items" width="200"/>
 106
 107 # Chat sounds
 108
 109 To activate chat sounds, you can add sounds as you want:
 110 You should put the sounds inside a .pk3 in the path `sound/chat/sound_name.ogg`
 111 For example:
 112 ```
 113 sound/chat/sound1.ogg
 114 sound/chat/sound2.ogg
 115 sound/chat/sound3.ogg
 116 ```
 117 Then you should set the following cvars in your server config:
 118 ```
 119 set sv_chat_sounds 1
 120 set sv_chat_sounds_list "sound1 sound2 sound3"
 121 ```
 122 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.
 123
 124 BaI server uses the following chat sounds configuration (chat sounds pk3 resource is needed to use these sounds):
 125 ```
 126 cmd sounds //to check chat sound list
 127 set sv_chat_sounds 1
 128 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"
 129 ```
 130
 131 You can write in the chat, the sound name to be played.
 132
 133 # Country flags
 134
 135 Keep in mind that country flags are saved inside zzz-bai-gfx-v8.pk3 file, each flag has its own number (0-249). Uses a bot to identify automatically player's IP and execute the following command:
 136
 137 `setflag #player_id numberofflag`
 138
 139 *Note* : this command can be tested on a server without this bot.
 140
 141 <img src="uploads/c71d78429cae68236204f572a61ce1fc/scoreboardCountryflag.jpg" alt="scoreboardCountryflag" width="500"/>
 142
 143 # References
 144
 145 https://omaera.org/~z411/xonotic/