Update Mapping packaging, also tell to save lightmaps

[xonotic/xonotic.wiki.git] / BaI-mod.md

diff --git a/BaI-mod.md b/BaI-mod.md
index 7e05bd7d387ad0d064a04661edfeef4ccd3e412f..f2c9bb9b22b944138f8c1cbc98c021cf42b290b2 100644 (file)
--- a/BaI-mod.md
+++ b/BaI-mod.md
@@ -1,7 +1,9 @@
 > ## Table of Contents
 > 1. [Notes for developers](#notes-for-developers)
-> 2. [Chat sounds](#chat-sounds)
-> 3. [References](#references)
+> 2. [HUD configuration](#hud-configuration)
+> 3. [Chat sounds](#chat-sounds)
+> 4. [Country flags](#country-flags)
+> 5. [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.
@@ -28,7 +30,7 @@ The resources should be saved in `PATH/data`.
 
 - Icons of country flags, medals and scoreboard logo:
 
-[zzz-bai-gfx-v7.pk3](uploads/68fc3a8a5ecad8d4a6bfa6e62b8f4a83/zzz-bai-gfx-v7.pk3)
+[zzz-bai-gfx-v8.pk3](uploads/c9dd058351dd79b05014293df321836d/zzz-bai-gfx-v8.pk3)
 
 - Soundtrack of when a match is over and the players are in pause voting to select gamemodes/maps:
 
@@ -54,6 +56,54 @@ LegendGuard has forked the mod and added some stuff in this branch: https://gitl
 
 Remember look the [**repository guide**](https://gitlab.com/xonotic/xonotic/-/wikis/Repository_Access) to use this code.
 
+#### List of source code files where mod was developed
+
+Client base:
+
+- [`qcsrc/server/client.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/server/client.qc)
+
+Scoreboard:
+
+- [`qcsrc/client/hud/panel/scoreboard.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/scoreboard.qc)
+
+- [`qcsrc/common/scores.qh`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/common/scores.qh)
+
+Chat:
+
+- [`qcsrc/client/hud/panel/chat.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/chat.qc)
+
+Spectator HUD:
+
+- [`qcsrc/client/hud/panel/spect.qh`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/spect.qh)
+
+- [`qcsrc/client/hud/panel/spect.qc`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/blob/z411/bai-server/qcsrc/client/hud/panel/spect.qc)
+
+Attacker text:
+
+- All files inside this folder:
+[`qcsrc/common/mutators/mutator/attackertext/`](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/z411/bai-server/qcsrc/common/mutators/mutator/attackertext)
+
+
+# HUD configuration
+
+Cvars: 
+
+`hud_spectatorteamdisplay 1 //sets team spectator display HUD`
+
+`hud_spectatorplayernamedisplay 1 //sets player name spectator display HUD`
+
+<img src="uploads/2dc395d83ac793aa20f502a1bfd5bb12/SpectatorHUD.jpg" alt="SpectatorHUD" width="500"/>
+
+
+`cl_attackertext 1 //sets attacker text to know who is attacking`
+
+<img src="uploads/19d0104a69a9bf92aa0b65c111ab0488/attackername.jpg" alt="attackername" width="200"/>
+
+
+`hud_itempickupdisplay 1 //sets item pickup display HUD`
+
+<img src="uploads/3d3d116722312d471408c7d178595e6d/items.jpg" alt="items" width="200"/>
+
 # Chat sounds
 
 To activate chat sounds, you can add sounds as you want:
@@ -80,6 +130,16 @@ set sv_chat_sounds_list "200 abusadores alert andate antabaka apruebo arigato au
 
 You can write in the chat, the sound name to be played.
 
+# Country flags
+
+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:
+
+`setflag #player_id numberofflag`
+
+*Note* : this command can be tested on a server without this bot.
+
+<img src="uploads/c71d78429cae68236204f572a61ce1fc/scoreboardCountryflag.jpg" alt="scoreboardCountryflag" width="500"/>
+
 # References
 
 https://omaera.org/~z411/xonotic/
\ No newline at end of file