Reaperbot Improvement Protocol v0.11 (RIP v0.11)
by legion, the ubiquitous llama-killer

PART I

PREFACE

INTRODUCTION

COPYRIGHTS AND PERMISSIONS

PREREQUISITES

   1) Reaperbot v0.81
      - ftp.cdrom.com/pub/quake/quakec/bots/reaper
   
   2) btsk23.zip
      -ftp.cdrom.com/pub/quake/quakec/bots
      - contains norse_movetogoal as well as Alan Kivlin's QCBot ranking
      code
      - demos are included showing off the new movement code.  E-mail me
      at legion@softhome.net if you think the Zeusbot's movement is
      better.  Provide an example (eg. a demo) proving your case
  
   3) ProQCC v1.52 or later
      - ftp.cdrom.com/pub/quake/quakec/utils
   
   4) v1.06 of QuakeC
      - many compilers come with v1.06 of QuakeC.  find one.
      - ftp.cdrom.com/pub/quake/quakec/utils
      - many compilers come with v1.06 of QuakeC.  Find one or visit
      MrPink's website.
   5) knowledge of directory structure and installation of QuakeC patches
      - visit http://www.planetquake.com/qca for help in this area
  
   6) knowledge of QuakeC (not for the novice)
      - variable definitions are a must
      - modifying and creating functions
      - visit Inside3D, http://www.planetquake.com/iqc, for plenty of
        examples on this.  The tutorials are packed with examples of
        modifying functions.  Practically all the tutorials include at
        least one example of modifying existing or creating functions.
      - function prototypes are a must
      - understanding of IF block and IF-ELSE block
      - visit Inside 3D, http://www.planetquake.com/iqc, for examples
        on this.  Many of the tutorials contain IF blocks or IF-ELSE
        block statments for you to look at and understand.
   
   7) a text editor equipped with a cut-n-paste feature
  
   8) the ability to follow instructions


CORRECTION PART I

Thanks to Sam Kenny, I have discovered that I made a mistake in one of my
explanations in Part I.  Recall that I said that when you decompile a patch
like the reaperbot, there can be missing lines of code.  Well, that part is
correct but then I said that the compiler doesn't understand bad code so
it leaves it blank.  It is the second part of the explanation that is wrong.
The compiler does compile the line, it is the DECOMPILER that does not
understand it and leaves it blank.  So for instance, lines like this found
in misc.qc
   if (!self.speed)
      self.speed == 1000;

are actually compiled into the progs.dat.  But when a decompiler like ProQCC
sees this code in the progs.dat, it gets "confused" and doesn't bother with
it any further because the next line it sees is the end of the function or
end of the IF block.  The result is that the decompiler does not print out
the code--it leaves it blank.  Thus, you have missing lines of code.  The
line itself, of course, is not actually executed by Quake since it is
garbage.  However, it is still part of the progs.dat and decompilers like
ProQCC leaves it blank in the decompiled source.

I realize that when some people decompile a patch and find the following
lines in misc.qc:
   if ( !self.speed ) {


   }

they believe, for some strange reason, that there are no missing lines of
code.  Their explanation, of course, is what I call the stupidly obvious.
Their explanation is that the line "self.speed == 1000;" is garbage so it
isn't executed by Quake.  That is obvious.   What isn't obvious is why they
insist that there are no missing lines of code in the above example?  I
see nothing in between the brackets.  Do you see anything between the
brackets?  I knew that decompilers leave out code but the experts said
otherwise.  I thought these experts were right; hence, my wrong explanation
in Part I. 

Decompilers are being developed as we speak that are able to print out the
missing lines of code.  I have seen and tested a prototype decompiler.  It
does indeed decompile lines of code like the one above.  Currently, it is
only able to decompile the line if that code is the very last line in an
IF block or the very last line of the function.  The other mistakes (if any)
in that function or IF block or WHILE block are not decompiled.  The
prototype is also able to correctly decompile correctly lines of code like
the following:
   self.currentammo = self.ammo_cells = self.ammo_cells - 1;

When the bugs are ironed out, don't be surprised to see a new decompiler
at ftp.cdrom.com.

On a related note, a descrambler is also in the works.  I haven't seen the
descrambler but I have seen the results.  The eliminatorbot v2.0 has been
successfully descrambled and decompiled.  If you haven't read my review on
the eliminatorbot or are still confused, the eliminatorbot v2.0 IS the
reaperbot with few additions like realistic momentum effects from weapon hits
and Alan Kivling's QCBot ranking code.

CORRECTION PART II

In Part II of the tutorial, I forgot a step in the W_FireLightning function
definition.  In the IF block that checks for self.ammo_cells < 1, add the
following lines of code BEFORE the return statement:
if (self.classname == "dmbot")
   self.think = self.th_run;

If you see a problem with the reaperbot stop moving after using the
lightning gun, then the above addition should remedy that problem.  Many
thanks goes to TheJoker for e-mailing me that there was something wrong with
the reapers while using the lightning gun.

Mr. Pink´s note: The RIP II tutorial has been updated correcting that error.


 
   BEGIN GUIDE: Part III
 





STEP 1

Modifying func.qc.  You will be adding a few new functions.  These functions
will be used for coop support and thud reduction.

   a) Using a method called cut-n-paste, add the following functions to the
      bottom of func.qc.

      /* Begin code */
      // New functions
      entity() find_bot =
      {
         local float dist;
         local float best_dist;
         local entity   head;
         local entity   selected;
       
         selected = world;
         best_dist = 9999;
      
         head = find (world, classname, "dmbot");
         while (head)
         {
            dist = vlen (self.origin - head.origin);
            if (infront(head) && visible(head) && (dist < best_dist) )
            {
               best_dist = dist;
               selected = head;
            }
          
            head = find (head, classname, "dmbot");
         }
       
         return selected;
      };

      entity() find_monster =
      {
         local float dist;
         local float best_dist;
         local entity   head;
         local entity   selected;
      
         selected = world;
         best_dist = 9999;
      
         head = findradius (self.origin, 600);
         while (head)
         {
            dist = vlen (self.origin - head.origin);
            if (infront(head) && visible(head) && (dist < best_dist) && (head.flags & FL_MONSTER) )
            {
               best_dist = dist;
               selected = head;
            }
          
            head = head.chain;
         }
       
         return selected;
      };
      
      void() thud_gone =
      {
      
         local float tol;
         tol = -80;
         tol = tol * cvar("sv_gravity")/800;
      
         if (self.flags & FL_ONGROUND)
         {
            if (self.velocity_z < tol)
            {
               self.flags = self.flags - (self.flags & FL_ONGROUND);
               self.velocity_z = tol;
            }
         }
      };

      void(entity me) set_bot_suicide_frame =
      {
      
         if (me.model != "progs/player.mdl")
            return; // already gibbed
         me.frame = 60;
         me.solid = SOLID_NOT;
         me.movetype = MOVETYPE_TOSS;
         me.deadflag = DEAD_DEAD;
         me.nextthink = -1;
      
      };
      /* End code */

   b) save changes.

STEP 2
Modifiying world.qc.

   a) search for the worldspawn function definition.  Add this line of code
      at the VERY BEGINNING of the function:
      clientInitMaxClients ();

   b) look for the line that says:
      entity bodyque_head;

      The above line should above the bodyque function definition.

      Delete that line.

   c) save changes.

STEP 3
Modifying botit_th.qc.

   a) Add the following lines of code at the top of the file:
      entity bodyque_head;
      .float LoggedIn;

   b) save changes.

STEP 4
Modifying bot_ai.qc.
   a) search for BotFoundTarget function definition.
      Change the line that says:
      if ( ((self.enemy.classname != "player") && (self.enemy.classname != "dmbot")) ) {
                  to
      if ( ((self.enemy.classname != "player") && (self.enemy.classname != "dmbot")) 
         && !(self.enemy.flags & FL_MONSTER)) {

   b) search for BotfindBot function definition.
      Look for the following IF block:
     /* Begin code */         
      if ( (bots.health > FALSE) ){
         self.enemy = bots;
         return (BotFoundTarget () );
      }
      /* End code */

      Replace the above code with the following:
      /* Begin code */         
      if ( (bots.health > 0) )
      {
         if (!coop)
         {
            self.enemy = bots;
            return (BotFoundTarget () );
         }
      }
      /* End code */

   c) search for the BotFindTarget function definition.
      Delete the lines that says the following:
    /* Begin code */
      client = checkclient ();
      if ( !client ) {
   
         return ( BotfindBot () );
   
      }
      /* End code */

      Replace the above lines of code with the following:
      /* Begin code */
      if (coop)
         client = find_monster ();

      if (!coop)
      {
         if (!client)
            client = checkclient ();
      }

      if (!client && !coop)
         return (BotfindBot ());  
      /* End code */

   d) search for ai_botrun function definition.
      AFTER the line that says:
      local float ang_ceil;

      Add the following:
      /* Begin code */
      if (self.enemy.flags & FL_MONSTER)
      {
         if (self.enemy.health <= 0)
         {
            endEnemy ();
            return;
         }
      }
      /* End code */

   e) search for aibot_chase function definition.
      AFTER the line that says:
      local float rnd;

      Add the following:
      /* Begin code */
      if (self.enemy.flags & FL_MONSTER)
      {
         if (self.enemy.health <= 0)
         {
            endEnemy ();
            return;
         }
      }
      /* End code */

   f) save changes.

STEP 5
modifying botspawn.qc.

   a) search for PutBotInServer function definition.
      AFTER the line that says:
      self.th_cache = cacheenemy;

      Add this line of code:
      self.touch = thud_gone;

      AT THE END of the function, add the following:
      /* Begin code */
      msgUpdateNameToAll (self.fClientNo, self.netname);
      msgUpdateColorsToAll (self.fClientNo, self.fShirt, self.fPants);
      msgUpdateFragsToAll (self.fClientNo, self.frags);
      /* End code */

   b) search for AddAnotherBot function definition.
      AFTER the line that says:
      local string st;

      Add the following:
      /* Begin code */
      local float cno;
      cno = clientNextAvailable ();
   
      if (cno == -1)
      {
         bprint ("Unable to spawn bot.  Server is full.\n");
         return;
      }
   
      clientSetUsed (cno);
      /* End code */

      Look for the lines of code that says the following:
      newbot = AddBot ();
      newbot.colormap = FALSE;

      AFTER those lines, add the following:
      /* Begin code */
      newbot.fClientNo = cno;
      if (!teamplay)
      {
         newbot.colormap = cno + 1;
         newbot.fShirt = floor (random() * 13);
         newbot.fPants = floor (random() * 13);
      }
   
      if (teamplay)
      {
         newbot.colormap = cno + 1;
         newbot.fShirt = 2;//newbot.colormap;
         newbot.fPants = 2;
      }
      /* End code */
            
      In teamplay mode, the reaperbots on the bots only team all have the
      same color--color #2.  You can choose another color if you want.
      Keep in mind that the bots will hunt down people on the other TEAM who
      may have the same color as the bots.

   c) search for addTeamBots function definition.
      AFTER the line that says:
      local float i;

      Add this line of code:
      local float cno;

      AFTER the line that says:
      while ( (i > FALSE) ) {

      Add the following lines of code:
      /* Begin code */
      cno = clientNextAvailable ();
      if (cno == -1)
		{
			bprint ("Unable to spawn bot.  Server is full.\n");
			return;
		}
      clientSetUsed (cno);
      /* End code */

      And yes, the above code should be inside the while block.

      Also inside the while block, look for these lines of code:
      newbot.team = ply.team;
      newbot.teamname = ply.netname;

      AFTER those lines, add the following:
      /* Begin code */
		newbot.fClientNo = cno;
		newbot.fShirt = newbot.team - 1;
		newbot.fPants = newbot.team - 1;		
      /* End code */

      Here, the bots on your team will have the same color as your pants.
      If you change teams after you spawned the bots, then they will no
      longer be on your team.  You just created another bots-only team.

   d) save changes.

STEP 6
Modifying ai.qc.

   a) look for FindTarget function definition.
      Delete the following lines of code from the function:
      /* Begin code */
      if (sight_entity_time >= time - 0.1 && !(self.spawnflags & 3) )
      {
         client = sight_entity;
         if (client.enemy == self.enemy)
            return;
      }
      else
      {
         client = checkclient ();
         if (!client)
            return FALSE;  // current check entity isn't in PVS
      }
      /* End code */

      Replace the above lines of code with the following:
      /* Begin code */
      client = world;
      if (coop)
         client = find_bot();
   
      if (!client)
         client = checkclient();
      /* End code */

      Also in this same function definition, change the line that says:
      if (self.enemy.classname != "player")
               to
      if (self.enemy.classname != "player" && self.enemy.classname != "dmbot")

      Change the OTHER line that says:
      if (self.enemy.classname != "player")
               to
      if (self.enemy.classname != "player" && self.enemy.classname != "dmbot")
   
   b) save changes.

STEP 7
Modifying client.qc.

   a) search for ClientKill function definition.
      AFTER the line that says:
      countkill (self, self);

      Add the following:
      msgUpdateFragsToAll (self.fClientNo, self.frags);

   b) search for PutClientInServer function definition.
      AT THE END of the function, add the following:
      /* Begin code */
      local float cno;
      if (!self.LoggedIn)
      {
         self.LoggedIn = TRUE;
         cno = clientNextAvailable ();
         self.fClientNo = cno;
         clientSetUsed (cno);
         msgUpdateNameToAll (cno, self.netname);
      }
      /* End code */

   c) search for ClientConnect function definition.
      AFTER the line that says:
      local entity e;

      Add the following:
      /* Begin code */
      local float cno;
      cno = clientNextAvailable ();
      self.fClientNo = cno;
      clientSetUsed (cno);
      msgUpdateNameToAll (cno, self.netname);
      self.LoggedIn = TRUE;
      /* End code */

   d) search for ClientDisconnect function definition.
      AFTER the line that says:
      self.classname = "nobody";

      Add this line of code:
      clientSetFree (self.fClientNo);

   e) search for ClientObituary function definition.
      Remember the pattern I mentioned the last time you modified this
      function.  Specifically, remember where you put all those countkill
      function calls.  Guess what?  You'll need to remember them.  There
      should be six countkill function calls.  So you will need to add
      six msgUpdateFragsToAll function calls as well.

      These msgUpdateFragsToAll function calls are the following:

      msgUpdateFragsToAll (attacker.owner.fClientNo, attacker.owner.frags);
      msgUpdateFragsToAll (targ.fClientNo, targ.frags);
      msgUpdateFragsToAll (attacker.fClientNo, attacker.frags);
      msgUpdateFragsToAll (attacker.fClientNo, attacker.frags);
      msgUpdateFragsToAll (attacker.fClientNo, attacker.frags);
      msgUpdateFragsToAll (targ.fClientNo, targ.frags);

      Obviously, you place the above function calls in the same place that
      the countkill function calls are.  And yes, there is a pattern.
      Whenever the frags has been updated (eg. you see something like
      "attacker.frags = attacker.frags + 1"), there is also a countkill
      function call and a msgUpdateFragsToAll function call.
      
   f) save changes.


STEP 8
Modifying combat.qc.

   a) search for T_Damage function definition.
      Look for this following lines of code:
      /* Begin code */
      if ( (inflictor != world) && (targ.movetype == MOVETYPE_WALK) )
      {
         dir = targ.origin - (inflictor.absmin + inflictor.absmax) * 0.5;
         dir = normalize(dir);
         targ.velocity = targ.velocity + dir*damage*8;
      }
      /* End code */

      AFTER the above IF block, add this IF block:
      /* Begin code */
      if ( (inflictor != world) && (targ.movetype == MOVETYPE_STEP) &&
         (targ.classname == "dmbot") )
      {
         dir = targ.origin - (inflictor.absmin + inflictor.absmax) * 0.5;
         dir = normalize(dir);
         targ.flags = targ.flags - (targ.flags & FL_ONGROUND);
         targ.velocity = targ.velocity + dir*damage*8;
      }
      /* End code */
      
      Look for the following lines of code:
      /* Begin code */
      if (attacker != self)
      {
         if (self.enemy)
            secondEnemy (attacker);
         else
         {
            self.enemy = attacker;
            BotFoundTarget ();
         }
      }
      /* End code */

      Replace the above code with the following:
      /* Begin code */      
      if (attacker != self && !coop)
      {
         if (self.enemy)
            secondEnemy (attacker); // tag the other target
         else
         {
            // we've been hit, make him the enemy
            self.enemy = attacker;
            BotFoundTarget ();
         }
      }
      /* End code */

   b) save changes.

STEP 9
Compile and have fun!