Added BaI mod, a mod with Quake 3 features

diff --git a/BaI-mod.md b/BaI-mod.md
new file mode 100644 (file)
index 0000000..7e05bd7
--- /dev/null
+++ b/BaI-mod.md
@@ -0,0 +1,85 @@
+> ## Table of Contents
+> 1. [Notes for developers](#notes-for-developers)
+> 2. [Chat sounds](#chat-sounds)
+> 3. [References](#references)
+
+
+[**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.
+
+
+# Notes for developers
+
+### Mod resources
+
+Note: PATH is one of the following depending on your system
+
+|OS|Path|
+|:--|:--|
+|Windows|C:\Users\yourusername\Saved Games\xonotic|
+|Linux|~/.xonotic|
+|Mac|~/Library/Application Support/xonotic|
+Nothing should *ever* be added to the main installation folder of Xonotic, use these paths!
+
+The resources should be saved in `PATH/data`.
+
+- Announcer (execute `cl_announcer shobon` command to activate the resource):
+
+[zzz-bai-announcer-v9.pk3](uploads/bc6f4532a636aae501c8a800ceed0eb2/zzz-bai-announcer-v9.pk3)
+
+- Icons of country flags, medals and scoreboard logo:
+
+[zzz-bai-gfx-v7.pk3](uploads/68fc3a8a5ecad8d4a6bfa6e62b8f4a83/zzz-bai-gfx-v7.pk3)
+
+- Soundtrack of when a match is over and the players are in pause voting to select gamemodes/maps:
+
+[zzz-bai-jingle-v1.pk3](uploads/8a541fbdf6d2ab0447567eb1e18d3e13/zzz-bai-jingle-v1.pk3)
+
+- Chat sounds:
+
+[zzz-bai-jokes-v18.pk3](uploads/f16e2c669c122f62d8ae663f4df18823/zzz-bai-jokes-v18.pk3)
+
+- Quickmenu:
+
+[zzz-bai-quickmenu-v2.pk3](uploads/7607735ad75ec0853a3f88a3ecf018ae/zzz-bai-quickmenu-v2.pk3)
+
+- Set of sound effects about when player shots, a flag is fallen, ...
+
+[zzz-bai-sounds-v11.pk3](uploads/247dc57e177a7d08c2b7ce7e42cd3995/zzz-bai-sounds-v11.pk3)
+
+### Source code
+
+The code is in z411's branch: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server
+
+LegendGuard has forked the mod and added some stuff in this branch: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/LegendaryGuard/bai_mod
+
+Remember look the [**repository guide**](https://gitlab.com/xonotic/xonotic/-/wikis/Repository_Access) to use this code.
+
+# Chat sounds
+
+To activate chat sounds, you can add sounds as you want:
+You should put the sounds inside a .pk3 in the path `sound/chat/sound_name.ogg`
+For example:
+```
+sound/chat/sound1.ogg
+sound/chat/sound2.ogg
+sound/chat/sound3.ogg
+```
+Then you should set the following cvars in your server config:
+```
+set sv_chat_sounds 1
+set sv_chat_sounds_list "sound1 sound2 sound3"
+```
+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.
+
+BaI server uses the following chat sounds configuration (chat sounds pk3 resource is needed to use these sounds):
+```
+cmd sounds //to check chat sound list
+set sv_chat_sounds 1
+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"
+```
+
+You can write in the chat, the sound name to be played.
+
+# References
+
+https://omaera.org/~z411/xonotic/
\ No newline at end of file