Browse Source

Update README proper, docs

Updated README for the usual boilerplate and whatnot; also updated some minor commentary explaining why we have #if directives in the code.
nosoop 7 years ago
parent
commit
e71fe53915
2 changed files with 20 additions and 3 deletions
  1. 19 2
      README.md
  2. 1 1
      scripting/csrd_extended_humiliation.sp

+ 19 - 2
README.md

@@ -1,3 +1,20 @@
-# CSRD-ExtendedHumiliation
+# Extended Humiliation Round Fixes
 
-Minor quality-of-life improvements for extended humiliation rounds.
+Minor quality-of-life improvements for extended humiliation rounds by performing a few things:
+
+1.  Hides the round win panel 5 seconds after the round is over.  Pairs well with an
+end-round Prop Hunt system as it prevents the win panel from covering up a good amount of the
+screen for the rest of the humiliation period.
+2.  Hides player health.  "The losers are all too concerned with trying to escape the
+victors that they don't notice how much health they have left" is what I'd like to think.
+
+## A "CSRD Internal" Plugin
+
+This is a plugin mainly intended for use in [Pikachu's Canadian Server of Romance and
+Drama][csrd].
+
+While I'm happy if you find some useful code for your own plugins, I can't provide any support
+for said code, nor will I offer any guarantees that the plugin will remain usable outside of its
+main use.
+
+[csrd]: https://csrd.science/

+ 1 - 1
scripting/csrd_extended_humiliation.sp

@@ -73,7 +73,7 @@ stock void TF2_HideWinPanel(const int[] clients, int numClients) {
 		Event event = CreateEvent("teamplay_round_start", true);
 		
 		#if SOURCEMOD_V_MAJOR >= 1 && SOURCEMOD_V_MINOR > 8
-		// avoid broadcasting event
+		// avoid broadcasting event; disabling broadcasts on 1.8 throws an error
 		event.BroadcastDisabled = true;
 		#endif