ASSS Wiki - User contributions [en]

Main Page

2010-09-18T14:11:22Z

D1st0rt: Undo revision 6140 by Francisco21 (Talk)

<div style="border: 1px solid #c6c9ff; background-color: #f0f0ff; text-align: center; font-variant: small-caps;">
Quicklinks:
[[:Category:ASSS|ASSS Documents]] | [[:Category:FAQ|Frequently Asked Questions]] | [[:Category:Guides|Guides]] | [[:Category:Definitions|Glossary]] | [[:Category:Utilities|Utilities]] | [[Special:Categories|More...]]
</div>

<table cellspacing=10><tr valign="top"><td>
<h3>What is ASSS?</h3>
[[ASSS]] (A Small Subspace Server) is an open source server, created by [[User:grelminar|grelminar]], that facilitates games among [[Continuum]] users. It's a replacement, not a clone, of [[Subgame]], which was the old server created by [[VIE]] and later upgraded by [[PriitK|Priit Kasesalu]], a freelance [[Subspace]] programmer who also wrote Continuum with the assistance of [[Mr Ekted]].

ASSS allows many advanced features never before offered by Subgame nor user-made [[Bots]]. Within this wiki, you'll find documents about how to use some of these advanced features, and documentation on how to create your own extensions to the server software. There is also an [[ASSS Commands Cheatsheet]] to help you get started.

To start finding answers, try the quicklinks (above) or check out the [[Special:Categories|Categories]]. If you're having problems with your server, try reading the [[Server Troubleshooting]] guide. If you would like to contribute see [[ASSS_Wiki:Community Portal|Community Portal]]. For further assistance or questions, please visit the [http://forums.minegoboom.com Server Help Forums] where other users will be able to respond to your questions.

<h3>External Links</h3>

*[http://asss.minegoboom.com/ Official ASSS Site]
*[http://www.shanky.com/server/ Server Help]
*[http://forums.minegoboom.com/ Server Help Forums]

</td><td style="width: 30%; border: 1px solid #c6c9ff; padding: 5px">

<h3>Current Events</h3>

ASSS version 1.4.4 has been released as of September 7, 2007. This version addresses several bug fixes, and now requires Continuum 0.40.

'''Download'''
*[http://asss.yi.org/files/asss-1.4.4.tar.gz Linux]
*[http://asss.yi.org/files/asss-1.4.4-srconly.tar.gz Source Only]
*[http://asss.yi.org/files/asss-1.4.4.zip Windows]
*[http://bitbucket.org/grelminar/asss/overview/ Change Log]

[[Current events|More Events...]]
</tr></table>

[[Category: Wiki]]

TWCore

2006-11-06T23:17:08Z

D1st0rt: Website down notice

TWCore is an open source bot core written in Java. Widely used in [[Trench Wars]] (TW) and [[Redstar]].

== Plugins ==
Source: http://forums.minegoboom.com/viewtopic.php?p=54919#54919

'''[[User:D1st0rt|D1st0rt]] says:'''
----
Acrobot runs acromania or whatever its called 
AlertBot sends alerts to players 
basicbot is just a blank bot 
bouncerbot kicks people out of arenas when they enter if they aren't allowed 
enigmabot runs enigma 
f1bot I assume does some type of racing 
mrarrogant kicks idlers and multiclienters 
purepubbot runs pure pubs 
robohelp does various administrative things 
staffbot does stuff involving potential staff considerations and viewing warnings current staff has made 
triviabot runs trivia 
twbot can be loaded with a ton of different modules for various things
----

== Download ==
*[http://www.ssdownloads.com/download.php?fid=1053 Version 0.89]

== Resources ==
*[http://twcore.twzone.net/core/ Official Website]
'''''Note''': The official website is currently down and has been for some time. A partially archived copy exists [http://web.archive.org/web/20050207064935/twcore.twzone.net/core/ here], and [http://www.google.com/search?q=twcore.twzone.net&filter=0 Google] has cached a few of the forum posts''

[[Category: Bots]]

Talk:Search Phrases

2005-10-17T22:04:19Z

D1st0rt: search topics

[[User:Mine GO BOOM|Mine GO BOOM]] 20:15, Oct 14, 2005 (EDT): Yes, that big asss joke is funny, but I put this here because it is interesting in finding what people are searching major search engines for, and what we could expand upon to include what some people want to find.

[[User:D1st0rt|D1st0rt]] 18:04, Oct 17, 2005 (EDT): By that token, we should put up a page on how to cheat and how to bypass bans :p It seems like the other main thing was how to set up specific game modes in asss, like how to set up a soccer or turf zone. I thought "pump that asss" was better than "big asss"

Talk:Latency

2005-03-27T14:39:10Z

D1st0rt: link for sync

[[User:D1st0rt|D1st0rt]]: This doesn't mean anything to me since I only skimmed through it, but might be useful to somebody else
http://catid.ssihosting.com/files/sync.txt

Talk:UDP Game Protocol

2005-03-13T04:49:01Z

D1st0rt: protocol link

[[User:Smong|Smong]]: Can you explain how to use the handler offsets. Which versions of Subspace they are valid for with MD5's of the binaries, and possible a link to the latest version.

[[User:D1st0rt|D1st0rt]]:I got [http://d1st0rt.sscentral.com/packets.html this one] from kirk's site, its a bit more in depth and include the directory server protocol

Talk:Ship Settings

2005-03-06T15:36:25Z

D1st0rt: rotation units

Isn't this kinda a pointless page? I mean, all this information is in [[Complete Settings]] and is dispersed in greater detail in each section's page. --[[User:Cyan~Fire|Cyan~Fire]]

[[User:Pests|Pests]]: This and Complete Settings are two different things. Theres a section in the template.sss named "All" and Complete Settings has EVERY section, including this "All" section.

That's pretty confusing, especially considering the section name "All" never appears in an actual config file. It's just a shorthand that means there are eight sections these settings can go in, one for each ship type. Futhermore, it would be good to differentiate between settings that apply to subgame, settings that apply to asss, and settings that apply to both, before just mindlessly dumping the contents of template.sss on here. --[[User:grelminar|grelminar]]

== my updates ==

OK, I don't think I have any questions on this one. But I do have a comment.

I'm pretty sure that energy and speed are Energy / 1000 * hundredths of seconds and Pixels / 1000 * hundredths of seconds, respectively. I also made a marginally tested educated guess that weapon speed units are the same as ship speed units. I also figured that Energy / seconds / 10 is a much easier to read format (I sure don't have to think so much), although a bit less standard. Any comments/questions/suggestions/curses? --[[User:Cyan~Fire|Cyan~Fire]]

[[User:Smong|Smong]]: I don't understand this: '90Â°/hundredths of seconds'.

I would think it would be 9Â°, since that is the rotation increment --[[User:D1st0rt|D1st0rt]]

Prize

2005-03-06T15:33:44Z

D1st0rt: elaborated on #-13 and #-14

A '''Prize''' is an upgrade to a ship in [[SubSpace]] which can either be picked up in a Green (a floating prize box), bought, or randomly given at spawn.

Each prize has an identifiying number, with the negative taking away the prize. Here they are:
*1 = Recharge
*2 = Energy
*3 = Rotation
*4 = Stealth
*5 = Cloak
*6 = XRadar
*7 = Warp
*8 = Guns
*9 = Bombs
*10 = Bouncing Bullets
*11 = Thruster
*12 = Top Speed
*13 = Full Charge (-13 is Energy Depleted)
*14 = Engine Shutdown (-14 is Severe Shutdown, lasts longer)
*15 = MultiFire
*16 = Proximity
*17 = Super!
*18 = Shields
*19 = Shrapnel
*20 = AntiWarp
*21 = Repel
*22 = Burst
*23 = Decoy
*24 = Thor
*25 = Multi
*26 = Brick
*27 = Rocket
*28 = Portal

MERVBot Tutorial

2005-02-17T20:59:20Z

D1st0rt: don't need subspace.bin anymore

This tutorial is based on the ever-popular MERVBot Tutorial by Underlord. It has since been updated to reflect new changes with MervBot.

This tutorial also assumes that you have a basic knowledge of C++. If you don't, check out cplusplus.com's great [http://www.cplusplus.com/doc documentation].

==Setting up a MERVBot (plugin)==

[http://catid.sscentral.com/ MERVBot download site]

[http://www.ssforum.net/ MERVBot Forum] (Development - MervBot forum)

===Obtaining MERVBot===

* Download the [http://catid.ssihosting.com/files/MERVBot.rar latest build].
* Unrar MERVBot.rar into a new folder. (example c:\program files\continuum\mervbot)
* Unzip src.zip into "src" subfolder of that new folder (example c:\program files\continuum\mervbot\src)

===Preparing to write a plugin===

''Note:'' if you only want to execute someone's premade plugin (.dll), skip to [[MERVBot Tutorial#Run your bot dll|step 4]], otherwise continue to learn how to make your own bot

Download [http://catid.sscentral.com/files/Tutorial.zip DLL-plugin Tutorial] and unzip Tutorial.zip (containing spawn.h, spawn.cpp, and command.cpp) into a "tutorial" subfolder of that new folder. (example c:\program files\continuum\mervbot\src\tutorial).

''File descriptions:''
* spawn.h = declare/initialize globals
* command.cpp = code for commands coming into bot (ie /!help, /!play, etc)
* spawn.cpp = code that interacts with bot spawns

===Microsoft Visual c++===

<ol>
<li>Start Visual Studios 6.0.
<li>Click the Drop Down Menu labeled "File" at the top left of your screen.
<li>Click "New".
<li>On the next screen that comes up, choose from the Project tab, then Win32 Dynamic-Link Library
<li>Select the "/src" folder as the base folder (example c:\program files\continuum\mervbot\src)
<li>Name your project "mybot". This will make a "mybot" subfolder in your "src" folder. Click OK. (example creates c:\program files\continuum\mervbot\src\mybot)
<li>Choose to create an "Empty DLL project".
<li>Click "Finish".
<li>Click the Drop Down Menu labbled "Project".
<li>Click "Add To Project Files"
<li>Copy only spawn.h, spawn.cpp, and command.cpp from the "tutorial" folder into the this new folder. (example from c:\program files\continuum\mervbot\src\tutorial to c:\program files\continuum\mervbot\src\mybot)
<li>Click the Drop Down Menu labelled "Build".
<li>Click "Build (dll name)" - where (dll name) is "mybot"
<li>Go into your "mybot" folder and look for a folder named "Debug"
(example c:\program files\continuum\mervbot\src\mybot\debug)
<li>Your new DLL will be in that folder. (example mybot.dll)
<li>Copy mybot.dll to your base folder that has mervbot.exe in it (example c:\program files\continuum\mervbot)
</ol>

===Run your bot dll===

To run your bot you need your DLL (mybot.dll), Commands.txt, MERVBot.exe, MERVBot.ini, Operators.txt, Spawns.txt, and zlib.dll all in one folder (example c:\program files\continuum\mervbot).

<ol>
<li>Edit spawns.txt. '''Read every word of spawns.txt to find out what needs to go in there.'''

 
''Example:''
<pre>2v2-Bot-League : botpw : 2v2a : 2v2league : staffpw</pre>

''Note:'' The bot will attempt to create the name if it doesn't exist already.

<li>Edit MERVBot.ini
 
 
<pre>[Login]
Zone=216.33.98.254:21000 // make that your zone IP:PORT available from zone.dat in Continuum dir
</pre>

<li>Edit operators.txt. '''Read every word of operators.txt to find out what needs to go in there.''' 

''Example:''
<pre>
4:my_name:
4:another_sysop:
3:other_person:
</pre>

<li>Make sure the bot is on vip.txt or has smod+ access, then run MERVBot.exe.

<li>You can now edit your plugin code by opening "mybot.dsw" (example c:\program files\continuum\mervbot\src\mybot\mybot.dsw) in Microsoft Visual C++. Edit the spawn.h, spawn.cpp, and command.cpp to create your plugin, then build, copy your updated DLL to your MERVBot.exe folder and then execute the bot. Use the tutorial to get ideas on how to implement certain types of features into the bot.

</ol>

==Player Commands - (command.cpp)==

This section describes how to implement player commands into your plugin. Commands are sent to the botInfo::gotCommand function in command.cpp.

Example (makes bot reply to !test with "hi"):
<pre>
void botInfo::gotCommand(Player *p, Command *c) {
switch (p->access)
{
case OP_Moderator:
{
// handle moderator-operator commands here.
}
case OP_Player: //appropriate staff rank here.
{
if (c->check("test")) //replace "test" with whatever command you want
{
//put your command code here
sendPrivate(p,"hi"); //example
}
}
</pre>

===How to have commands with numerical parameters===
Example (!test #):
<pre>
if (c->check("test")) { // reads in test #, default to 1 if invalid number input
int temp = 1;

if (isNumeric(c->final))
temp = atoi(c->final);
</pre>

===How to have player name as input===
Example (!rank player):
<pre>
if (c->check("rank"))
{
String player_name = c->final;

if (player_name.IsEmpty()) // default name to self if invalid name
player_name = p->name;
</pre>

===How to have multi-parameter input===

Use the CRT function sscanf() to scan the string for the values.

Example (!squads squadA vs squadB ''or'' !squads teamA:squadA:teamB:squadB):
<pre>
else if (c->check("squads"))
{
char squadA[20], squadB[20];
int teamA, teamB;

strncpy(squadA, "", 20);
strncpy(squadB, "", 20);

int n_found;

//Note: %[A-Za-z ] is equivalent to %s, but allows an internal space.

//scan the string for the two squads separated by " vs "
n_found = sscanf(c->final, "%[A-Za-z ] vs %[A-Za-z ]", squadA, squadB);

//if that fails, scan the string for freqA:squadA:freqB:squadB
if (n_found < 2)
sscanf(c->final, "%d:%[A-Za-z ]:%d:%[A-Za-z ]", &teamA, squadA, &teamB, squadB);
}
</pre>

===Help Menu===
When a player sends !help to the bot, MERVBot calls botInfo::gotHelp() in each plugin loaded.
<pre>
void botInfo::gotHelp(Player *p, Command *c)
{
if (!*c->final)
{
sendPrivate(p, "4v4 Bot General Commands:");
sendPrivate(p, "------------------------");
sendPrivate(p, "!caps - get captain names");
sendPrivate(p, "!roster <squad> - get roster of a squad");
sendPrivate(p, "!schedule- get current schedule");
sendPrivate(p, "!score - get current score");
</pre>

==Event Calls==

MERVBot is event based, so when making a bot you need to decide what will happen at certain events. Normal plugins need to consider what happens when bot enters arena, player enters arena, player leaves arena, player events like kill, shipchange, teamchange, spec, move then any other relevant events to your bot. Just worry about events that are relevant to the tasks your bot is doing.

MERVBot sends events to botInfo::gotEvent() in spawn.cpp. Each supported event is already present and categorized in gotEvent(), along with the paramters that MERVBot sends with the event. When a plugin wants the bot to do something, it sends tell(event) to the bot.

See dllcore.h for a list of current events and their descriptions. Dllcore.h also contains functions (like makeFollowing) to make events to send back to the bot via tell().

<pre>tell(makeFollowing(false));</pre>

==The Messaging System==

Private message - void sendPrivate(Player *player, char *msg);

''Examples:''

<pre>
sendPrivate(p,"hi");

String s="test";
sendPrivate(p,s);

String s="test";
s += "ing";
sendPrivate(p,s);

char captain1[20];
char captain2[20];
strncpy(captain1,"",20);
strncpy(captain2,"",20);
sendPrivate(p,(String) captain1 + " and " + (String) captain2 + " are the captains.");
</pre>

Team message - void sendTeamPrivate(Uint16 team, char *msg); 
<blockquote>Examples: 
a) sendTeamPrivate(8025,"hi spec freq"); 
b) Uint16 test=0; sendTeamPrivate(test,"hi freq 0"); 
</blockquote>

Public message - void sendPublic(char *msg); 
<blockquote>Example: sendPublic("*arena " + (String) p->name + " is now a captain"); 
</blockquote>
Chat channel message - void sendChannel(char *msg); 
<blockquote>Example: sendChannel("hi chat channel"); 
</blockquote>
Remote private message - void sendRemotePrivate(char *name, char *msg); 
<blockquote>Example: sendRemotePrivate("Player01", "hi"); 
</blockquote>

Note: to have bot print several lines of text fast it needs sysop in the
arena (sysop in arena bot first spawns to also) otherwise it'll print slow to avoid being
kicked for spam

===Output of data in messages===
An example of using normal strings to output data/messages.
<pre>
// does *arena X pilots left in game
// NOTE: variable temp needs to be defined with some value

String s = "*arena ";
s += temp;
s += " pilots left in the game.";

sendPublic(s);
</pre>
Or,
<pre>
//NOTE: this can be considered inefficient.

sendPublic("*arena " + (String)temp + " pilots left in the game");
</pre>

An example using sprintf to align/space data, where output data will be in this approximate format.
<pre>
// output data will be in this approximate format (not lined up perfectly because of html)
// --------------------------------------------------------------------------------------
// Squad: squadname PTS FPTS K D DMG DEALT TAKEN F FK FLT
// --------------------------------------------------------------------------------------
// PlayerA 10000 500 116 101 9999 99999 10 150 980:55
// PlayerB 500 200 7 5 9999 99999 5 3 0:04

char str[255];
sendPublic("*arena--------------------------------------------------------------------------------");

sprintf(str, "*arena Squad: %-20s PTS FPTS K D DMG DEALT TAKEN F FK FLT",
freqs[freq].freqname
);

sendPublic(str);

sendPublic("*arena--------------------------------------------------------------------------------");

// assuming existing freqs struct with data
for (pilot=freqs[freq].playercount-1; pilot>=0; pilot--)
{
// on freq squad so print stats
char outString[255];

sprintf(outString, "*arena %-20s %12d %8d %3d %3d %10d %6d %2d %3d %3d:%02d",
freqs[freq].pilots[pilot].name,
freqs[freq].pilots[pilot].points,
freqs[freq].pilots[pilot].flagpoints,
freqs[freq].pilots[pilot].kills,
freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].dmgdealt,
freqs[freq].pilots[pilot].dmgtaken,
freqs[freq].pilots[pilot].flags,
freqs[freq].pilots[pilot].flagkills,
freqs[freq].pilots[pilot].flagtime /60,
freqs[freq].pilots[pilot].flagtime %60
);

sendPublic(outString);
}

// Notes: sprintf format = sprintf(output char string, spacing, variables)
// Notes: s = chars, d = integer, - = left align, right align default
// Notes: doing %02d = put 0 in front if not 2 digits, %3d:%02d makes 0:04 format
</pre>

==Timer - How to use the timing function==

Each time MERVBot sends an EVENT_Tick to a plugin (once a second), the default handler code decrements each value in an array of countdowns. You can modify the number of countdowns and add code to occur at a specific value for one of the countdowns.

Setup number of timers and initialize in spawn.h:
<pre>
class botInfo
{
#define COUNTDOWNS 10 // how many countdowns you want
int countdown[COUNTDOWNS]; // this gives you 10 timers

// unrelated code

public:
botInfo(CALL_HANDLE given)
{
countdown[0] = 0;
countdown[1] = 60; // 60 seconds
//
// initialize values
//
countdown[9] = 5*60; // 5 minutes
</pre>
Using timer functions in spawn.cpp:
<pre>
case EVENT_Tick:
{
for (int i = 0; i < COUNTDOWNS; ++i) //cycles through each countdown you have
--countdown[i]; //note that countdowns will continue decrementing past 0.

if (countdown[1] == 2) // when timer #1 hits two seconds
{
// do stuff here when timer #1 hits 2 seconds
// example: sendPublic("two seconds left, setting timer to 1 minute");
// example: countdown[1] = 60; // change timer #1 value
}
</pre>

You can then have events (such as EVENT_PlayerDeath) change the value of a countdown to make the bot do something a set time after an event occurs.

==Writing Functions==

For this example, we will take the function called closeto, which determines
if a player exists in an specific radius around a point. Now to apply this function to a MervBot plugin, you need to write it into the spawn.cpp - at the top of the file in the //////// DLL "import" //////// setion, as below:
<pre>
//////// DLL "import" ////////

bool closeto(Player *p, int x, int y, int tolerance)
{
// Requires the function abs() to be declared elsewhere.
// Return if player p is in area of square with center x, y
// and radius = tolerance
return (abs((p->tile.x) - x) - tolerance) && (abs((p->tile.y) - y) - tolerance);
}
</pre>

If you want your function to have access to the data from spawn.h botInfo class, you make the function apart of it. To do this, we add the '''botInfo::''' infront of the function name, in spawn.cpp.
<pre>
//////// DLL "import" ////////

bool botInfo::closeto(Player *p, int x, int y, int tolerance)
{
...
}
</pre>
In '''spawn.h''', add your method's prototype without botInfo::, it will look
like this:
<pre>
//...
botInfo(CALL_HANDLE given)
{
// ...
}
bool closeto(Player *p, int x, int y, int tolerance); // Your function prototype.

void clear_objects(); //provided by Catid, and already exists.
void object_target(Player *p); //provided by Catid, and already exists.
// ...
};
</pre>
If you're not familiar with prototypes, notice it is similar to that in your spawn.cpp, but without the botInfo::, and a trailing ;.

===Function notes===

Remember that you can pass variables [http://www.cplusplus.com/doc/tutorial/tut2-3.html by reference]. If variables are passed by reference, any changes a function makes to the variables will remain after the function returns.

From time to time you will need to pass an array to a function. An example illustrating this is:
<pre>
int freqs[5]; // declare our example data.

// call function - notice freqs and not freqs[5] or freqs[].
my_function(freqs); //You're not passing the array itself, just a pointer to the array.

// function - notice freqs[] and not freqs[5] or freqs
void my_function(int freqs[]) {} //You're specifying that the freqs parameter is an array
</pre>

==Cycling through players==

MERVBot stores player-related data in a linked list. A linked list is a datatype that stores its data in a series of structures linked to each other, hence the name.

To search through the players in the arena, just start at the first link, then continue through all the following links until you reach the end:
<pre>
_listnode <Player> *parse = playerlist->head; //set to first link of the player linked list

while (parse) //parse will be NULL when we reach the last link
{
Player *p = parse->item; //item is the actual data stored in the link

// do functionality here
// Example 1: sendPrivate(p,"*watchdamage"); // turns on all pilot's watchdamage
// Example 2: if (p->safety != 0) sendPrivate(p,"*spec"); // spec all pilots in safe zone

parse = parse->next; //set parse to the next link
}
</pre>

For example, assuming our bot has smod+ privilages, the following code will set all non-spectator players to a specific ship. First begin by adding the following function prototype to the spawn.h in the botInfo class:
<pre>
void handleCmdSetShip(enum Ship_Types ship);
</pre>

In spawn.cpp add:
<pre>
void botInfo::handleCmdSetShip(enum Ship_Types ship)
{
//Note that the parameter ship is of the Ship_Types enum,
//so its value is hopefully restricted to the proper types.

_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item;

if ( p->ship != ship && p->ship != SHIP_Spectator )
sendPrivate(p, "*setship " + (String)ship);

parse = parse->next;
}
}
</pre>

To use, just call the function with the appropriate Ship_Type from the enum in clientprot.h:
<pre>
handleCmdSetShip(SHIP_Warbird);
</pre>

==Random numbers==

===Generating a random number===

To use this method, these two includes must be used:
<pre>
#include "time.h" //provides time() function.
#include "stdlib.h" //provides srand() and rand() functions.
</pre>

Use:
<pre>
srand(time(NULL)); // seed random number generator.

rand(); // randomize.

int temp = (int) (51 * ((float)rand()/RAND_MAX));
// the above line returns a random integer between 0 and 51.
// Note: RAND_MAX is a global constant defined in stdlib.h
</pre>

===Picking a random pilot===

''Note:'' A required user-defined function, getInGame(), must be created for this example to work.

<pre>
int temp = GetTickCount() % getInGame(); // getInGame() = how many pilots in arena

Player *rabbit = NULL;

_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item;

if (p->ship != SHIP_Spectator) // if player is not a spectator
if ( !(--temp) ) // and if we've hit the randomly-selected pilot
{
rabbit = p;
break;
}
parse = parse->next;
}
</pre>

==Tracking time not using countdown[n]==

This is a solution to a common problem of determining the amount of time it takes for something to occur. Using basic math, we record a start-time B, and an end-time E, both in the unit of seconds, we calculate the time elapsed by E-B.

Lucky for us, Windows provides a function called GetTickCount() that is a measurement of time (milliseconds) that we can use for such cases.

So:
<pre>
int begin = GetTickCount();

// do some code here.

int end = GetTickCount();

int delta = (end - begin) / 1000; // elapsed time converted to seconds from milliseconds
</pre>

==Storing data for pilots==

There are several ways to store data for pilots (ie tracking flagtime or kills in a period of time). Note that these methods are all purely internal to the bot, and don't effect anything beyond the plugin in any way.

# Built-in get/setTag: Tracks data until player leaves the arena, then automatically deletes data.
# Modified perm get/setTag: Tracks data until bot leaves arena, then automatically deletes data. (Advantage: easier to sort by player)
# Custom Structs: Tracks data until plugin deletes it. (Advantage: easier to sort by freqs)

''Note:'' 2 and 3 are similar in effect, mostly the difference is in how you are able to search through data you need to decide which method of storing data is best for each bot depending on what it does.

===Built-in get/setTag method===

Player tags simply tag a player with a number. Define the wanted values in '''spawn.h''' at the top:
<pre>
#define DMG_DEALT 0
#define DMG_TAKEN 1
</pre>

In spawn.cpp, initialize the values on ArenaEnter and PlayerEnter:
<pre>
case EVENT_ArenaEnter:
{
// ...

// do for all pilots in arena when bot enters
_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item; // get pilot

set_tag(p, DMG_DEALT, 0); // initialize to 0
set_tag(p, DMG_TAKEN, 0);
sendPrivate(p, "*watchdamage"); // optionally turn on player *watchdamage

parse = parse->next; // get next pilot
}
}
</pre>
<pre>
case EVENT_PlayerEntering:
{
// ...
set_tag(p, DMG_DEALT, 0); // initialize to 0
set_tag(p, DMG_TAKEN, 0);
sendPrivate(p,"*watchdamage");
}
</pre>

Then somewhere edit the tag values:
<pre>
case EVENT_WatchDamage:
{
// sets tag for k (shooter) to be old value plus damage currently dealt

int old_damage = get_tag(k, DMG_BOMB_DEALT);
set_tag(k, DMG_BOMB_DEALT, old_damage + damage);
}
</pre>

The following demonstrates how to retrieve the tag values as a command in command.cpp:
<pre>
if (c->check("showstats"))
{
int temp = get_tag(p, DMG_TOTAL_DEALT);

String s = "You've done ";
s += temp;
s += " damage so far!";

sendPrivate(p,s);
}
</pre>

===Modified permanent get/setTag method===

This method is the same as get/setTag with some modifications to the tag code to retain them after the player leaves. Beware of using this method if bot is in an arena for long periods of time, linkedlist could get huge.

// spawn.h, add char name[20]; into struct PlayerTag
<pre>
struct PlayerTag
{
Player *p;
char name[20];
int index;
int data;
};
</pre>

In spawn.cpp:
<pre>
case EVENT_PlayerLeaving:
{
Player *p = (Player*)event.p[0];

// killTags(p); // remove so tag not deleted on arena exit

// ...
</pre>

Locate in spawn.cpp and modify accordingly:
<pre>
int botInfo::get_tag(Player *p, int index)
{
_listnode <PlayerTag> *parse = taglist.head;
PlayerTag *tag;

while (parse)
{
tag = parse->item;

// if (tag->p == p)
if (strcmp(tag->name,p->name)==0) // now tracking by player name, not pointer
if (tag->index == index)
return tag->data;

parse = parse->next;
}
return 0;
}

void botInfo::set_tag(Player *p, int index, int data)
{
_listnode <PlayerTag> *parse = taglist.head;
PlayerTag *tag;

while (parse)
{
tag = parse->item;

//if (tag->p == p)
if (strcmp(tag->name,p->name)==0) // now tracking by player name, not pointer
if (tag->index == index)
{
tag->data = data;
return;
}
parse = parse->next;
}

tag = new PlayerTag;
// tag->p = p; // not tracking by pointer anymore
strncpy(tag->name, p->name, 20); // tracking by player name
tag->index = index;
tag->data = data;
taglist.append(tag);
}
</pre>

===Using structs, implement in spawn.h:===

<pre>
class botInfo
{
struct freqdata
{
int kills, deaths;
};
// ...
};
</pre>

To make use of this structure, implement accordingly:
<pre>
freqdata freqs[100]; // 100 of those structs
</pre>
Access the data in spawn.cpp using
<pre>
freqs[56].kills = 1;
</pre>

==Input/Output to files==

For reading and/or writing to files with C++ you must have the required include statement as follows:
<pre>
#include <fstream>
using namespace std; // not a good practice, but works.
</pre>

''Note'': neither example shows how to properly handle possible error-exceptions.

===File stream input===
The following example will show you how to read a file, duel.ini, line by line.

<pre>#include "stdlib.h" // for atoi()</pre>

<pre>
ifstream file("duel.ini");
char line[256];

// read in MaxBoxes=X
while (file.getline(line, 256))
{

if (CMPSTART("MaxBoxes=", line)) //Does the line begin with MaxBoxes= ?
{
MAX_BOXES = atoi(&(line[9])); //If so, read the value into an integer, using atio.
break;
}
}

file.close();
</pre>

===File stream output===
The following code example will demonstrate how to append to a file, duelleaguestat.inc.
<pre>
ofstream file("duelleaguestat.inc", ios::app); // app = put all data at end of file
file << squad1<< endl; // squad1 = char[20]
file << " vs "<< endl;
file << squad2<< endl; // squad2 = char[20]
file.close();
</pre>

Similarly, you are able to write an output of a String to a file:
<pre>
// key is converting String to (char*) to file write
String str = freqs[freq].slotname[slot];
str += ", Repels: " + (String)(int) t->repel;
file << endl;
file << (char*) str;
</pre>

===Input with GetPrivateProfileString===

GetPrivateProfileString(), a function provided by Windows for reading INI files, will automatically find an INI key (like "MaxBoxes=") in a file for you. See the [http://msdn.microsoft.com/library MSDN Library] for help on this function. This next example will show how to read input using GetPrivateProfileString() based on the rampage plugin.

The file format for rampage.ini is like this:
<pre>
7=is on a killing spree! (6:0)
10=is opening a can of booya! (9:0)
</pre>

In '''rampageini.cpp''':
<pre>
#include "rampageini.h"
#define WIN32_LEAN_AND_MEAN
#include <windows.h>

#define NUM_RANKS 10
#define BUFFER_LEN 256

struct RampageSettings
{
char quotes[NUM_RANKS][BUFFER_LEN];
};

void LoadSettings(RampageSettings &setts);

static char path[BUFFER_LEN];

char *rank_type[NUM_RANKS] = { "7", "10" };

void LoadSettings(RampageSettings &setts)
{
GetCurrentDirectory(BUFFER_LEN - 64, path);
strcat(path, "\rampage.ini");

for (int i = 0; i < NUM_RANKS; ++i)
{
GetPrivateProfileString("Comments", rank_type[i], "-ERROR-",
setts.quotes[i], BUFFER_LEN, path);
}
}
</pre>

==Player data==

As stated earlier in the tutorial, MervBot stores useful player data internally as Player objects, see player.h for implementation details.

* p->name = player name stored as char[20] (''Note:'' SubSpace protocol allows for usernames to be 19+ in length, do not rely on this for player-name comparisions.)
* p->squad = player squad stored as char[20]
* p->ship = ship (0-9) enumerated as SHIP_Warbird, SHIP_Spectator, etc..
* p->safety = whether ship is in safety zone (boolean)
* p->bounty = player bounty
* p->energy = player energy (have bot with *energy on to get accurate readings)
* p->flagCount = how many flags player is holding
* p->team = player frequency
* p->(burst, repel, thor, brick, decoy, rocket, portal) = how many items of that type player has
* p->(stealth, cloak, xradar, awarp, ufo, flash, safety, shields, supers) = if player has that item on (boolean)
* p->score.killPoints = player kill points
* p->score.flagPoints = player flag points
* p->score.wins = player kills from f2
* p->score.losses = player deaths from f2

Just access the respective member of the Player class to check the player's property.

For example, in spawn.cpp, to check whether a player is in a safety zone:
<pre>
EVENT_PlayerMove:
{
Player *p = (Player*)event.p[0];

if ( p->safety ) // player is in safe zone.
{
// do something.
}

if ( !p->safety ) // player NOT in safe zone.
{
// do something.
}
}
</pre>

==Bot built in functions==

Here are some useful MervBot commands to control what the bot is doing.

Player.cpp:
* Player::move(Sint32 x, Sint32 y) moves a player to the coordinates specified by x and y
* Player::clone(Player *p) clones a player into a player class

Look in Commands.txt , command.cpp (core), or /!help to bot to see all bot external commands (example /!go <arena>).

''LVZ Object toggling commands in plugins are to go here.''

==Example Code==




 -->

 -->
==== No antiwarp in center of the map ====

'''Example A''': No antiwarp in center of map. Warn the player, and revoke the prize.
In order for this code to work correctly, the bot must have smod+ privilages.
Lets first implement two functions which we will need to accomplish this task:
<pre>
bool closeto(Player *p, int x, int y, int tolerance) {
return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); }

inline int abs(int n) {
if (n < 0) return -n;
else return n; }
</pre>

We should define the radius of antiwarp checking, this can be done several ways, for sake of simplicity, here is a quick-plop-in for '''spawn.h''':
<pre>
class botInfo
{
bool CONNECTION_DENIED;
...
// Put bot data here
int radius;

public:
botInfo(CALL_HANDLE given)
{
...
// Put initial values here
radius = 35;
...
</pre>
Locate and add into '''spawn.cpp''' accordingly:
<pre>
case EVENT_PlayerMove:
{

Player *p = (Player*)event.p[0];

// no anti in center
if ((p->ship != SHIP_Spectator) && (p->awarp)) {
if (closeto(p, 512, 512, radius)){
sendPrivate(p, "*prize #-20");
sendPrivate(p, "*warn Antiwarp is not allowed in center.");
}
}
...
</pre>
Just as a word of caution, players may at times be flooded with *prize #-20, and *warn statements under certain conditions.

 
==== Setting freq size depending on how many pilots in game ====

'''Example B''': Setting freq size depending on how many pilots in game.
In order for this code to work correctly, the bot must have Sysop or Arena-Owner privilages.
In '''spawn.cpp''' (Note: this source code has assumptions, please review comments before implementing.):
<pre>
case EVENT_Tick:
{
...

// NOTE: assuming countdown[0] initialized to > 0 in spawn.h, freqchange=0;
if (countdown[0] == 0)
{
_listnode <Player> *parse = playerlist->head;
int count = 0;

while (parse)
{
Player *p = parse->item;

if (p->ship != SHIP_Spectator)
++count;

parse = parse->next;
}

if ((count > 24) && (freqchange != 4))
{
sendPublic("?set team:maxperteam:4"); //Sysop command to modify arena config.
String s;
s = "Max freq size 4 (";
s += count;
s += " pilots in game)";
sendPublic(s);
freqchange = 4;
}

if ((count < 25) && (count > 14) && (freqchange != 3))
{
sendPublic("?set team:maxperteam:3"); //Sysop command to modify arena config.
String s;
s = "Max freq size 3 (";
s += count;
s += " pilots in game)";
sendPublic(s);
freqchange = 3;
}

countdown[0] = 120; // reset timer to 120 seconds.
}
</pre> 
==== Tracking kills and announcing when pilot gets 10 kills in a row without dying ====

'''Example C''': Tracking kills and announcing when pilot gets 10 kills in a row without
dying.
In order for this code to work correctly, the bot must have smod+ privilages.
Locate EVENT_PlayerDeath in '''spawn.cpp''' (see note.):
<pre>
EVENT_PlayerDeath:
{
Player *p = (Player*)event.p[0],
*k = (Player*)event.p[1];
Uint16 bounty = (Uint16)(Uint32)event.p[2];
Uint16 flags = (Uint16)event.p[3];

// NOTE: assuming tags are setup (see storing data section).
set_tag(p, KILLS, 0); // pilot died, reset to 0 kills in a row
set_tag(k, KILLS, get_tag(k, KILLS) + 1); // pilot killed someone, increment kills in a row by 1

if (get_tag(k, KILLS) == 10)
sendPublic("*arena (String) k->name + " has gotten 10 kills.");
...
}
</pre>
 
==== Warp pilot to coord when they are in a certain region ====

'''Example D''': Warp pilot to coord when they are in a certain region.
In order for this code to work correctly, the bot must have smod+ privilages.
Lets first implement two functions which we will need to accomplish this task:
<pre>
bool closeto(Player *p, int x, int y, int tolerance) {
return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); }

inline int abs(int n) {
if (n < 0) return -n;
else return n; }
</pre>

In '''spawn.cpp''', EVENT_PlayerMove:
<pre>
case EVENT_PlayerMove:
{
Player *p = (Player*)event.p[0];

if (closeto(p, 509, 509, 2)) // if pilot within 2 of map coord 509,509
{
sendPrivate(p, "*warpto 509 504"); // warp to coord 509,504
}
...
</pre>
 
==== Structures within structures ====

'''Example E''': Structures within structures (spawn.h botinfo).
Implement the following in the spawn.h:
<pre>
struct playerstats
{
char name[20];

int kills;
int deaths;
Uint16 points;
Uint16 flagpoints;
int flagtime;
int cflagtime;
int flags;
int flagkills;

int dmgdealt;
int dmgtaken;
};

struct freqdata
{
playerstats pilots[100];

int freqpoints;
char freqname[20];
int freqflagpoints;
Uint16 freqteam;
int freqflagtime;

int flags;
int kills;
int deaths;
int flagkills;

int dmgdealt;
int dmgtaken;

int playercount;
};

//... (large jump down in spawn.h)

// Put bot data here <- locate and add after:
freqdata freqs[100];

//... <- perhaps some other variables.. scroll down past the next }
}

void Clear(); // A user-defined function. Add this.

void clear_objects(); //already exists, provided by Catid.
void object_target(Player *p); //already exists, provided by Catid.

// ... spawn.h continues.
</pre>

Implement the following in '''spawn.cpp''':
<pre>
void botInfo::Clear()
{
// initialize/clear struct data
for (int n=99; n>=0; n--)
{
freqs[n].freqteam=-1;
freqs[n].freqpoints=0;
freqs[n].freqflagpoints=0;
freqs[n].playercount=0;
freqs[n].flags=0;
freqs[n].kills=0;
freqs[n].deaths=0;
freqs[n].freqflagtime=0;
freqs[n].flagkills=0;
freqs[n].dmgdealt=0;
freqs[n].dmgtaken=0;

for (int m = 99; m>=0; m--)
{
freqs[n].pilots[m].deaths=0;
freqs[n].pilots[m].kills=0;
freqs[n].pilots[m].points=0;
freqs[n].pilots[m].flagpoints=0;
freqs[n].pilots[m].flagtime=0;
freqs[n].pilots[m].cflagtime=0;
freqs[n].pilots[m].flags=0;
freqs[n].pilots[m].flagkills=0;
freqs[n].pilots[m].dmgdealt=0;
freqs[n].pilots[m].dmgtaken=0;
}
}
}
</pre>

To access private data:
<pre>freqs[1].pilots[2].kills++;</pre>
-OR-
<pre>int freq = p->team;
freqs[freq].deaths++;</pre>
 
==== Tracking flag data ====

'''Example F''': Tracking flag data.

'''Note''': This example relies on structs from example e.

'''Note''': case EVENT_FlagDrop: {} gets called anytime theres a teamkill.

<pre>
bool botInfo::GetPilot(Player *p)
{
// get a pilots freq/pilot id from struct
for (freq=freqcount-1; freq>=0; freq--)
if (p->team == freqs[freq].freqteam)
for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--)
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0)
return true;
return false;
}
</pre>

Example way to track flag data using above struct/functions, in '''spawn.cpp''':
<pre>
case EVENT_FlagGrab:
{
//... existing code

if (GetPilot(p)) // function
{
freqs[freq].pilots[pilot].flags++;
freqs[freq].flags++;

if (freqs[freq].pilots[pilot].flags < 2) // didnt have a flag before, first flag
freqs[freq].pilots[pilot].cflagtime = GetTickCount(); // time stamp when picked up flag
}

//... continuing code
</pre>

Example way to track flag data using built in get/set tag (from catid flagbot), in '''spawn.cpp''':
<pre>
case EVENT_FlagGrab:
{
//... existing code

set_tag(p, TAG_STAT_FS, get_tag(p, TAG_STAT_FS) + 1);
set_tag(p, TAG_FLAGTIMER, GetTickCount());

//... existing code
}
</pre>

Get current flag times using struct format:
<pre>
void botInfo::SetFlagTimes()
{
// set current flagtime for pilots/freqs
_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

if (GetPilot(p))
if (freqs[freq].pilots[pilot].flags > 0)
{
if (PilotOnSquad(p))
freqs[freq].freqflagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000;

freqs[freq].pilots[pilot].flagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000;
freqs[freq].pilots[pilot].cflagtime = GetTickCount();
}

parse = parse->next;
}
}
</pre>
 

==== Example way to do simple /!spam feature (allowed 1x/60s) ====

'''Example G''': Example way to do simple /!spam feature (allowed 1x/60s).

Declare and initialize variables in spawn.h:
<pre>
//... extra code.

class botInfo
{
//... extra code.

// Put bot data here
bool spamready;
int SPAM_TIME;

//... perhaps more variables.

public:
botInfo(CALL_HANDLE given)
{

//... extra code.

// Put initial values here
spamready = true;
SPAM_TIME = 60;

//... continuing code
</pre>

Spawn.cpp - mark as spamready=true when 60 seconds up:
<pre>
case EVENT_Tick:
{
//...

if (countdown[0] == 1)
spamready = true;
}
</pre>

Command.cpp - handle !spam command
<pre>
case OP_Player: // Player-level commands
{
//... continuing code ...
if (c->check("spam"))
{
// zone announcement "Need pilots to duel in ?go arena -pilotname"
if (spamready == true)
{
String s;
s += "*zone Need pilots to duel in ?go ";
s += arena;
s += " - ";
s += p->name;
sendPublic(s);

spamready=false;
countdown[0] = SPAM_TIME * 60; // next spam time limit
}
else if (countdown[0] < 0)
{
sendPrivate(p, "Spam ability disabled.");
}
else
{
String s;
s += SPAM_TIME;
s += " Minute timer between announcements. ";
s += countdown[0] / 60;
s += ":";
if (countdown[0] % 60 < 10)
s += "0";
s += countdown[0] % 60;
s += " minutes left before next spam allowed.";
sendPrivate(p, s);
}
}
</pre>
 

==== Implementing a simple stack to do "next in line for several 'boxes' at once" ====

'''Example H''': Example of implementing a simple stack to do "next in line for several 'boxes' at once".
In '''spawn.h''' declare the following variables and structs:
<pre>
class botInfo
{
//...

// Put bot data here <- locate and add after
Player *next[99][99];
int MAX_NEXT;
int nextcount[99];

public:
botInfo(CALL_HANDLE given)
{
//...

// Put initial values here <- locate and add after
MAX_NEXT = 8;

//... spawn.h continues on.
</pre>
In '''spawn.cpp''' implement (remember to add the function prototype to spawn.h as well.):
<pre>
void botInfo::MoveUp(int pos, int box)
{
// moves up the next line for that box and decrement box's nextcount
if (nextcount[box] > 0)
nextcount[box]--;

for (pos = pos; pos < MAX_NEXT - 1; pos++)
{
next[box][pos] = next[box][pos + 1];
}

next[box][MAX_NEXT] = 0;
}
</pre>

 

==== Example of reading any text from a .txt and printing it to pilot line by line ====

'''Example I''': Example of reading any text from a .txt and printing it to pilot line by line.
Required include:
<pre>#include <fstream>
using namespace std; // bad coding practice, but for ease of use, we'll use it.
</pre>
Example of use, in command.cpp:
<pre>
case OP_Player:
{
//...

if (c->check("staff"))
{
// read in data line by line from the file staff.txt (max length 255)
ifstream file("staff.txt");
char line[256];

while (file.getline(line, 256))
{
sendPrivate(p, line);
}
file.close();
}

//... command.cpp continues.
</pre>

 

==== Example of printing player stats grid ====

'''Example J''': Example of printing player stats grid.
'''Note''': This example code relies on previously discussed material. Please see the section "structures within structures" example for variable declarations, varibale freqcount = # of freqs.
'''Note''': User defined function ''sendFreqs'' is required.
In '''spawn.cpp''':
<pre>
void botInfo::DisplayPlayers()
{
// Display Match player/freq stats in this format
// ---------------------------------------------------
// Squad: squad_name_1 K D TK DMG DEALT TAKEN
// ---------------------------------------------------
// Player_1 0 0 0 0 0
// Player_2 0 0 0 0 0
// TOTAL: 0 0 0 0 0
// ---------------------------------------------------
// Squad: squad_name_2 K D TK DMG DEALT TAKEN
// ---------------------------------------------------
// Player_3 0 0 0 0 0
// Player_4 0 0 0 0 0
// Player_5 0 0 0 0 0
// TOTAL: 0 0 0 0 0
// ---------------------------------------------------

for (freq=freqcount-1; freq>=0; freq--)
{
char str[255];

sendFreqs("---------------------------------------------------");

sprintf(str, "Squad: %-20s K D TK DMG DEALT TAKEN", freqs[freq].freqname);

sendFreqs(str);

sendFreqs("---------------------------------------------------");

for (pilot=freqs[freq].playercount-1; pilot >= 0; pilot--)
{
sprintf(str, "%-20s %8d %2d %2d %9d %5d",
freqs[freq].pilots[pilot].name,
freqs[freq].pilots[pilot].kills,
freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].teamkills,
freqs[freq].pilots[pilot].dmgdealt,
freqs[freq].pilots[pilot].dmgtaken
);
sendFreqs(str);
}

sprintf(str, "TOTAL: %2d %2d %2d %9d %5d",
freqs[freq].kills, freqs[freq].deaths,
freqs[freq].teamkills,
freqs[freq].dmgdealt,
freqs[freq].dmgtaken
);
sendFreqs(str);
}

sendFreqs("---------------------------------------------------");
}
</pre>

 

==== Checking if any pilots are within a region ====

'''Example K''': Example of checking if any pilots are within a region.
'''Note''': User-defined function ''GetPilotName'' is missing, and needs to be implemented.See prior examples.
'''Note''': User-defined function ''closeto'' is missing, and needs to be implemented. See prior examples.
In spawn.cpp ('''Note''': you will also need to add the function prototype to spawn.h accordingly):
<pre>
bool botInfo::FreqAInBox()
{
// return true if teamA has a pilot in the box, otherwise false
for (int tempplayercount = freqs[0].playercount-1; tempplayercount >= 0; tempplayercount--)
if (GetPilotName(freqs[0].pilots[tempplayercount].name))
if (closeto(TempPlayer, coordX, coordY, 73) && (TempPlayer->ship != SHIP_Spectator))
return true;

return false;
}
</pre>

 

==== Functions to get a pilot's struct id info from a name or *player info ====

'''Example L''': Example of functions to get a pilot's struct id info from a name or *player info.
'''Note''': Required structures needed for this example to work. See structure examples for variable information.
'''Note''': Remember to implement any function into the spawn.h accordingly.
'''Note''': Using pilot names as vital comparisions should be used with caution. See [http://cypherjf.sscentral.com/articles/botsasclients.html Bot-Issues] by CypherJF.
'''Note''' from Underlord: It is "better to implement these functions as passing values by reference instead of using global variables... [it is] just easier to not have to be declaring different int freq, int pilot all the time."
In spawn.cpp:
<pre>
// return struct freq/pilot id from *player info
bool botInfo::GetPilot(Player *p)
{
// return freq, pilot of a player p
for (freq=freqcount-1; freq>=0; freq--)
if (p->team == freqs[freq].freqteam)
for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--)
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0)
return true;

return false;
}
</pre>
<pre>
// return *player as TempPlayer info from p->name info
bool botInfo::GetPilotName(char *name)
{
// get pilot from a name, return as TempPlayer
_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

// convert both to lowercase to compare
char pname[20];
strncpy(pname,p->name,20);

char nname[20];
strncpy(nname,name,20);

tolower(pname);
tolower(nname);

if (strcmp(pname,nname)==0)
{
TempPlayer = p;
return true;
}

parse = parse->next;
}
return false;
}
</pre>

 

==== Creating a logfile name using date and squad names ====

'''Example M''': Example of creating a logfile name using date and squad names.
Example Output: 03y01m27dBLACKDRaGON vs Integral05h08m.txt.
Format: year, month, day, squadA vs squadB, hour, minute.
'''Note''': Assuming you define the following variables: squadA (String), squadB (String).

<pre>
// create log file name (squadA and squadB external char[20] variables)
char u[100];
time_t t=time(NULL);
tm *tmp = localtime(&t);
strftime(u,99,"%y",tmp);
logname = u;
logname += "y";
strftime(u,99,"%m",tmp);
logname += u;
logname += "m";
strftime(u,99,"%d",tmp);
logname += u;
logname += "d";
logname += squadA;
logname += " vs ";
logname += squadB;
strftime(u,99,"%I",tmp);
logname += u;
logname += "h";
strftime(u,99,"%M",tmp);
logname += u;
logname += "m";
logname += ".txt";
</pre>

 

==== Sending messages to playing freqs or public and logging depending on status ====

'''Example N''': Example of sending messages to playing freqs or public and logging depending on status.
'''Note''': Assumes you have the following variables declared: teamA (String), teamB (String), logname (String).
'''Note''': Remember to implement the function prototypes into spawn.h
Required include statements:
<pre>
#include <fstream>
using namespace std; // bad coding practice, but it works.
</pre>

In spawn.cpp:
<pre>
// teamA, teamB, logname global variables
void botInfo::sendFreqs(char *msg)
{
char *mmsg = "*arena";
String s = msg;

if (teammsgs == false)
{
s.prepend("*arena ",7);
sendPublic(s);
}
else
{
sendTeamPrivate(8025,msg);
sendTeamPrivate(teamA,msg);
sendTeamPrivate(teamB,msg);
}
if (gameon == true)
{
ofstream outf(logname, ios::app);
outf << msg << endl;
outf.close();
}
}
</pre>

 

==== Reading in all player/freqs to struct data ====

'''Example O''': Example of reading in all player/freqs to struct data.

'''Note''': see structures within structures example for freqs[] declaration.

'''Note''': remember to add the function prototypes to spawn.h.

<pre>
// to get freqs in a game where there are several freqs
void botInfo::GetFreqs()
{
// read pilots into freq struct data from ingame and on playing freqs

_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

if (p->ship != SHIP_Spectator)
if (closeto(p, coordX, coordY, 73))
{
// look for freq in struct
bool foundfreq=false;

freq=freqcount-1;

while ((freq>=0) && (foundfreq==false))
{
if (p->team == freqs[freq].freqteam)
{
foundfreq=true;
strncpy(freqs[freq].pilots[freqs[freq].playercount].name, p->name, 20);
freqs[freq].playercount++;
}
freq--;
}

// didnt find freq in struct so add new freq
if (foundfreq == false)
{
if (manualsquads == false)
{
strncpy(freqs[freqcount].freqname, p->squad, 20);

if (freqcount == 0)
{
teamA = p->team;
strncpy(squadA, p->squad, 20);
}
else
{
teamB = p->team;
strncpy(squadB, p->squad, 20);
}
}
else
{
if (p->team == teamA)
strncpy(freqs[freqcount].freqname,squadA,20);
else if (p->team == teamB)
strncpy(freqs[freqcount].freqname,squadB,20);
}

freqs[freqcount].freqteam = p->team;

strncpy(freqs[freqcount].pilots[0].name, p->name, 20);

freqs[freqcount].playercount++;
freqcount++;
}
}
parse = parse->next;
}
}
</pre>

<pre>
// to get freqs in a game where there are only two teams
void botInfo::GetFreqs()
{
// read pilots into freq struct data from ingame and on playing freqs
_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

if ((p->ship != SHIP_Spectator) && ((p->team == teamA) || (p->team == teamB)))
{
// freq 100, team A
// set freq
freq = 0;

if (p->team == teamB)
freq = 1;

// number of pilots on freq counted so far, starts 0
pilot = freqs[freq].playercount;

// pilot name
strncpy(freqs[freq].pilots[pilot].name, p->name, 20);
// time stamp for playing time
freqs[freq].pilots[pilot].cplaying_time = GetTickCount();

// slot name
if (freqs[freq].playercount < NUMBER_PILOTS)
strncpy(freqs[freq].slotname[pilot], p->name, 20);

// increment freq player count
freqs[freq].playercount++;

// if freq not already have name, give it player squad name
if ((manualsquads == false) && (strlen(p->squad) > 0))
strncpy(freqs[freq].freqname, p->squad, 20);

// set player ship
freqs[freq].pilots[pilot].ship = p->ship + 1;
}

parse = parse->next;
}
}
</pre>
 

==== Finding MVP from struct data (2*kills - deaths formula) ====

'''Example P''': Example of finding MVP from struct data (2*kills - deaths formula).

<pre>
int highest = -20;
int mvp = 0;

for (pilot = freqs[mvpteam].playercount-1; pilot >=0; pilot--)
{
if (((freqs[mvpteam].pilots[pilot].kills * 2) - freqs[mvpteam].pilots[pilot].deaths) > highest)
{
mvp = pilot;
highest = (freqs[mvpteam].pilots[pilot].kills * 2) - freqs[mvpteam].pilots[pilot].deaths;
}
}
</pre>

 
==== Print time stamp of event ====

'''Example Q''': Print time stamp of event.
<pre>#include "time.h" // required include</pre>Use:
<pre>
char u[100];
time_t t=time(NULL);
tm *tmp = localtime(&t);
strftime(u,99,"%c",tmp);
sendPublic("Current date and time: " + (String) u);
</pre>
 
==== Simple way to track player bomb/bullet damage stats ====

'''Example R''': Simple way to track player bomb/bullet damage stats.
'''Note''': see data section for how to setup set_tag.
'''Note''': see clientprot.h for weapon information.
In '''spawn.cpp''':
<pre>
case EVENT_WatchDamage:
{
if (PLAYING) // if tracking stats
{
if ((wi.type == PROJ_PBomb) && (p->name != k->name))
{
set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT) + damage);
set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT) + damage);
set_tag(p, DMG_BOMB_TAKEN, get_tag(p, DMG_BOMB_TAKEN) + damage);
set_tag(p, DMG_TOTAL_TAKEN, get_tag(p, DMG_TOTAL_TAKEN) + damage);
}
else if (wi.type == PROJ_BBullet)
{
set_tag(k, DMG_BULLET_DEALT, get_tag(k, DMG_BULLET_DEALT) + damage);
set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT) + damage);
set_tag(p, DMG_BULLET_TAKEN, get_tag(k, DMG_BULLET_TAKEN) + damage);
set_tag(p, DMG_TOTAL_TAKEN, get_tag(k, DMG_TOTAL_TAKEN) + damage);
}
}
</pre> 

==== Simple way to print those stats ====

'''Example S''': Simple way to print those stats.
<pre>
case OP_Moderator:
{
if (c->check("showstats"))
{
sendPublic("Showing stats:");

_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

if (get_tag(p, DMG_TOTAL_DEALT) > 0)
{
char str[256];
sprintf(str, "(%-20s Dmg Dealt: Total %0004d, Bomb %0004d, Bullet %0004d Dmg TAKEN: Total %0004d, Bomb %0004d, Bullet %0004d)",
p->name,
get_tag(p,DMG_TOTAL_DEALT),
get_tag(p,DMG_BOMB_DEALT),
get_tag(p,DMG_BULLET_DEALT),
get_tag(p,DMG_TOTAL_TAKEN),
get_tag(p,DMG_BOMB_TAKEN),
get_tag(p,DMG_BULLET_TAKEN)
);

sendPublic(str);
}
parse = parse->next;
}
}
}
</pre> 


==== Make bot spectate specific coordinates ====

'''Example T''': Make bot spectate specific coordinates.

<pre>
// make bot spectate the coord 512,600
// possible use - capturing weapon packets in a specific region

tell(makeFollowing(false));
tell(makeFlying(true));
me->move(512 * 16, 600 * 16);
tell(makeSendPosition(true));
</pre>

MERVBot Tutorial

2005-02-15T23:32:05Z

D1st0rt: merv comes in .rar's

This tutorial is based on the ever-popular MERVBot Tutorial by Underlord. It has since been updated to reflect new changes with MervBot.

This tutorial also assumes that you have a basic knowledge of C++. If you don't, check out cplusplus.com's great [http://www.cplusplus.com/doc documentation].

==Setting up a MERVBot (plugin)==

[http://catid.sscentral.com/ MERVBot download site]

[http://www.ssforum.net/ MERVBot Forum] (Development - MervBot forum)

===Obtaining MERVBot===

* Download the [http://catid.ssihosting.com/files/MERVBot.rar latest build].
* Unzip MERVBot.zip into a new folder. (example c:\program files\continuum\mervbot)
* Unzip src.zip into "src" subfolder of that new folder (example c:\program files\continuum\mervbot\src)

===Preparing to write a plugin===

''Note:'' if you only want to execute someone's premade plugin (.dll), skip to [[MERVBot Tutorial#Run your bot dll|step 4]], otherwise continue to learn how to make your own bot

Download [http://catid.sscentral.com/files/Tutorial.zip DLL-plugin Tutorial] and unzip Tutorial.zip (containing spawn.h, spawn.cpp, and command.cpp) into a "tutorial" subfolder of that new folder. (example c:\program files\continuum\mervbot\src\tutorial).

''File descriptions:''
* spawn.h = declare/initialize globals
* command.cpp = code for commands coming into bot (ie /!help, /!play, etc)
* spawn.cpp = code that interacts with bot spawns

===Microsoft Visual c++===

<ol>
<li>Start Visual Studios 6.0.
<li>Click the Drop Down Menu labeled "File" at the top left of your screen.
<li>Click "New".
<li>On the next screen that comes up, choose from the Project tab, then Win32 Dynamic-Link Library
<li>Select the "/src" folder as the base folder (example c:\program files\continuum\mervbot\src)
<li>Name your project "mybot". This will make a "mybot" subfolder in your "src" folder. Click OK. (example creates c:\program files\continuum\mervbot\src\mybot)
<li>Choose to create an "Empty DLL project".
<li>Click "Finish".
<li>Click the Drop Down Menu labbled "Project".
<li>Click "Add To Project Files"
<li>Copy only spawn.h, spawn.cpp, and command.cpp from the "tutorial" folder into the this new folder. (example from c:\program files\continuum\mervbot\src\tutorial to c:\program files\continuum\mervbot\src\mybot)
<li>Click the Drop Down Menu labelled "Build".
<li>Click "Build (dll name)" - where (dll name) is "mybot"
<li>Go into your "mybot" folder and look for a folder named "Debug"
(example c:\program files\continuum\mervbot\src\mybot\debug)
<li>Your new DLL will be in that folder. (example mybot.dll)
<li>Copy mybot.dll to your base folder that has mervbot.exe in it (example c:\program files\continuum\mervbot)
</ol>

===Run your bot dll===

To run your bot you need your DLL (mybot.dll), Commands.txt, MERVBot.exe, MERVBot.ini, Operators.txt, Spawns.txt, subspace.bin, and zlib.dll all in one folder (example c:\program files\continuum\mervbot).

<ol>
<li>Edit spawns.txt. '''Read every word of spawns.txt to find out what needs to go in there.'''

 
''Example:''
<pre>2v2-Bot-League : botpw : 2v2a : 2v2league : staffpw</pre>

''Note:'' The bot will attempt to create the name if it doesn't exist already.

<li>Edit MERVBot.ini
 
 
<pre>[Login]
Zone=216.33.98.254:21000 // make that your zone IP:PORT available from zone.dat in Continuum dir
</pre>

<li>Edit operators.txt. '''Read every word of operators.txt to find out what needs to go in there.''' 

''Example:''
<pre>
4:my_name:
4:another_sysop:
3:other_person:
</pre>

<li>Make sure the bot is on vip.txt or has smod+ access, then run MERVBot.exe.

<li>You can now edit your plugin code by opening "mybot.dsw" (example c:\program files\continuum\mervbot\src\mybot\mybot.dsw) in Microsoft Visual C++. Edit the spawn.h, spawn.cpp, and command.cpp to create your plugin, then build, copy your updated DLL to your MERVBot.exe folder and then execute the bot. Use the tutorial to get ideas on how to implement certain types of features into the bot.

</ol>

==Player Commands - (command.cpp)==

This section describes how to implement player commands into your plugin. Commands are sent to the botInfo::gotCommand function in command.cpp.

Example (makes bot reply to !test with "hi"):
<pre>
void botInfo::gotCommand(Player *p, Command *c) {
switch (p->access)
{
case OP_Moderator:
{
// handle moderator-operator commands here.
}
case OP_Player: //appropriate staff rank here.
{
if (c->check("test")) //replace "test" with whatever command you want
{
//put your command code here
sendPrivate(p,"hi"); //example
}
}
</pre>

===How to have commands with numerical parameters===
Example (!test #):
<pre>
if (c->check("test")) { // reads in test #, default to 1 if invalid number input
int temp = 1;

if (isNumeric(c->final))
temp = atoi(c->final);
</pre>

===How to have player name as input===
Example (!rank player):
<pre>
if (c->check("rank"))
{
String player_name = c->final;

if (player_name.IsEmpty()) // default name to self if invalid name
player_name = p->name;
</pre>

===How to have multi-parameter input===

Use the CRT function sscanf() to scan the string for the values.

Example (!squads squadA vs squadB ''or'' !squads teamA:squadA:teamB:squadB):
<pre>
else if (c->check("squads"))
{
char squadA[20], squadB[20];
int teamA, teamB;

strncpy(squadA, "", 20);
strncpy(squadB, "", 20);

int n_found;

//Note: %[A-Za-z ] is equivalent to %s, but allows an internal space.

//scan the string for the two squads separated by " vs "
n_found = sscanf(c->final, "%[A-Za-z ] vs %[A-Za-z ]", squadA, squadB);

//if that fails, scan the string for freqA:squadA:freqB:squadB
if (n_found < 2)
sscanf(c->final, "%d:%[A-Za-z ]:%d:%[A-Za-z ]", &teamA, squadA, &teamB, squadB);
}
</pre>

===Help Menu===
When a player sends !help to the bot, MERVBot calls botInfo::gotHelp() in each plugin loaded.
<pre>
void botInfo::gotHelp(Player *p, Command *c)
{
if (!*c->final)
{
sendPrivate(p, "4v4 Bot General Commands:");
sendPrivate(p, "------------------------");
sendPrivate(p, "!caps - get captain names");
sendPrivate(p, "!roster <squad> - get roster of a squad");
sendPrivate(p, "!schedule- get current schedule");
sendPrivate(p, "!score - get current score");
</pre>

==Event Calls==

MERVBot is event based, so when making a bot you need to decide what will happen at certain events. Normal plugins need to consider what happens when bot enters arena, player enters arena, player leaves arena, player events like kill, shipchange, teamchange, spec, move then any other relevant events to your bot. Just worry about events that are relevant to the tasks your bot is doing.

MERVBot sends events to botInfo::gotEvent() in spawn.cpp. Each supported event is already present and categorized in gotEvent(), along with the paramters that MERVBot sends with the event.

See dllcore.h for a list of current events and their descriptions.

==Messaging - How to use the messaging system==

Private message - void sendPrivate(Player *player, char *msg);

''Examples:''

<pre>
sendPrivate(p,"hi");

String s="test";
sendPrivate(p,s);

String s="test";
s += "ing";
sendPrivate(p,s);

char captain1[20];
char captain2[20];
strncpy(captain1,"",20);
strncpy(captain2,"",20);
sendPrivate(p,(String) captain1 + " and " + (String) captain2 + " are the captains.");
</pre>

Team message - void sendTeamPrivate(Uint16 team, char *msg); 
<blockquote>Examples: 
a) sendTeamPrivate(8025,"hi spec freq"); 
b) Uint16 test=0; sendTeamPrivate(test,"hi freq 0"); 
</blockquote>

Public message - void sendPublic(char *msg); 
<blockquote>Example: sendPublic("*arena " + (String) p->name + " is now a captain"); 
</blockquote>
Chat channel message - void sendChannel(char *msg); 
<blockquote>Example: sendChannel("hi chat channel"); 
</blockquote>
Remote private message - void sendRemotePrivate(char *name, char *msg); 
<blockquote>Example: sendRemotePrivate("Player01", "hi"); 
</blockquote>

Note: to have bot print several lines of text fast it needs sysop in the
arena (sysop in arena bot first spawns to also) otherwise it'll print slow to avoid being
kicked for spam 

==Timer - How to use the timing function==

Each time MERVBot sends an EVENT_Tick to a plugin (once a second), the default handler code decrements each value in an array of countdowns. You can modify the number of countdowns and add code to occur at a specific value for one of the countdowns.

Setup number of timers and initialize in spawn.h:
<pre>
class botInfo
{
#define COUNTDOWNS 10 // how many countdowns you want
int countdown[COUNTDOWNS]; // this gives you 10 timers

// unrelated code

public:
botInfo(CALL_HANDLE given)
{
countdown[0] = 0;
countdown[1] = 60; // 60 seconds
//
// initialize values
//
countdown[9] = 5*60; // 5 minutes
</pre>
Using timer functions in spawn.cpp:
<pre>
case EVENT_Tick:
{
for (int i = 0; i < COUNTDOWNS; ++i) //cycles through each countdown you have
--countdown[i]; //note that countdowns will continue decrementing past 0.

if (countdown[1] == 2) // when timer #1 hits two seconds
{
// do stuff here when timer #1 hits 2 seconds
// example: sendPublic("two seconds left, setting timer to 1 minute");
// example: countdown[1] = 60; // change timer #1 value
}
</pre>

You can then have events (such as EVENT_PlayerDeath) change the value of a countdown to make the bot do something a set time after an event occurs.

==Writing Functions==

For this example, we will take the function called closeto, which determines
if a player exists in an specific radius around a point. Now to apply this function to a MervBot plugin, you need to write it into the spawn.cpp - at the top of the file in the //////// DLL "import" //////// setion, as below:
<pre>
//////// DLL "import" ////////

bool closeto(Player *p, int x, int y, int tolerance)
{
// Requires the function abs() to be declared elsewhere.
// Return if player p is in area of square with center x, y
// and radius = tolerance
return (abs((p->tile.x) - x) - tolerance) && (abs((p->tile.y) - y) - tolerance);
}
</pre>

If you want your function to have access to the data from spawn.h botInfo class, you make the function apart of it. To do this, we add the '''botInfo::''' infront of the function name, in spawn.cpp.
<pre>
//////// DLL "import" ////////

bool botInfo::closeto(Player *p, int x, int y, int tolerance)
{
...
}
</pre>
In '''spawn.h''', add your method's prototype without botInfo::, it will look
like this:
<pre>
//...
botInfo(CALL_HANDLE given)
{
// ...
}
bool closeto(Player *p, int x, int y, int tolerance); // Your function prototype.

void clear_objects(); //provided by Catid, and already exists.
void object_target(Player *p); //provided by Catid, and already exists.
// ...
};
</pre>
If you're not familiar with prototypes, notice it is similar to that in your spawn.cpp, but without the botInfo::, and a trailing ;.

===Function notes===

Remember that you can pass variables [http://www.cplusplus.com/doc/tutorial/tut2-3.html by reference]. If variables are passed by reference, any changes a function makes to the variables will remain after the function returns.

From time to time you will need to pass an array to a function. An example illustrating this is:
<pre>
int freqs[5]; // declare our example data.

// call function - notice freqs and not freqs[5] or freqs[].
my_function(freqs); //You're not passing the array itself, just a pointer to the array.

// function - notice freqs[] and not freqs[5] or freqs
void my_function(int freqs[]) {} //You're specifying that the freqs parameter is an array
</pre>

==Cycling through players==

MERVBot stores player-related data in a linked list. A linked list is a datatype that stores its data in a series of structures linked to each other, hence the name.

To search through the players in the arena, just start at the first link, then continue through all the following links until you reach the end:
<pre>
_listnode <Player> *parse = playerlist->head; //set to first link of the player linked list

while (parse) //parse will be NULL when we reach the last link
{
Player *p = parse->item; //item is the actual data stored in the link

// do functionality here
// Example 1: sendPrivate(p,"*watchdamage"); // turns on all pilot's watchdamage
// Example 2: if (p->safety != 0) sendPrivate(p,"*spec"); // spec all pilots in safe zone

parse = parse->next; //set parse to the next link
}
</pre>

For example, assuming our bot has smod+ privilages, the following code will set all non-spectator players to a specific ship. First begin by adding the following function prototype to the spawn.h in the botInfo class:
<pre>
void handleCmdSetShip(enum Ship_Types ship);
</pre>

In spawn.cpp add:
<pre>
void botInfo::handleCmdSetShip(enum Ship_Types ship)
{
//Note that the parameter ship is of the Ship_Types enum,
//so its value is hopefully restricted to the proper types.

_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item;

if ( p->ship != ship && p->ship != SHIP_Spectator )
sendPrivate(p, "*setship " + (String)ship);

parse = parse->next;
}
}
</pre>

To use, just call the function with the appropriate Ship_Type from the enum in clientprot.h:
<pre>
handleCmdSetShip(SHIP_Warbird);
</pre>

==Checking if pilot is in a safe zone==
MervBot keeps track of whether a player is in safe or not by accessing a member of the Player class. 
* if (p->safety != 0) // pilot is in a safe zone 
* if (p->safety == 0) // pilot is NOT in a safe zone 
An example goes as follows, in spawn.cpp:
<pre>
...
EVENT_PlayerMove:
{
Player *p = (Player*)event.p[0];

if ( p->safety ) // player is in safe zone.
{
// do something.
}

if ( !p->safety ) // player NOT in safe zone.
{
// do something.
}
}
...
</pre>


==Random numbers==

===Generating a random number===

To use this method, these two includes must be used:
<pre>
#include "time.h" //provides time() function.
#include "stdlib.h" //provides srand() and rand() functions.
</pre>

Use:
<pre>
srand(time(NULL)); // seed random number generator.

rand(); // randomize.

int temp = (int) (51 * ((float)rand()/RAND_MAX));
// the above line returns a random integer between 0 and 51.
// Note: RAND_MAX is a global constant defined in stdlib.h
</pre>

===Picking a random pilot===

''Note:'' A required user-defined function, getInGame(), must be created for this example to work.

<pre>
int temp = GetTickCount() % getInGame(); // getInGame() = how many pilots in arena

Player *rabbit = NULL;

_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item;

if (p->ship != SHIP_Spectator) // if player is not a spectator
if ( !(--temp) ) // and if we've hit the randomly-selected pilot
{
rabbit = p;
break;
}
parse = parse->next;
}
</pre>

==Tracking time not using countdown[n]==

This is a solution to a common problem of determining the amount of time it takes for something to occur. Using basic math, we record a start-time B, and an end-time E, both in the unit of seconds, we calculate the time elapsed by E-B.

Lucky for us, Windows provides a function called GetTickCount() that is a measurement of time (milliseconds) that we can use for such cases.

So:
<pre>
int begin = GetTickCount();

// do some code here.

int end = GetTickCount();

int delta = (end - begin) / 1000; // elapsed time converted to seconds from milliseconds
</pre>

==Storing data for pilots==
There are several ways to store data for pilots (ie tracking flagtime or kills in a period of time)

1) get/setTag - use if you only want to track data until pilot leaves arena then its erased 
built in tags track by an ID that is reset when pilot leaves/enters arena, so loses track of data once they leave arena

2) modified perm get/setTag - use if you want to track all pilots even if they leave (advantage - easier to sort by player) also can track near unlimited amount of pilots

3) structs - use to track all pilots even if they leave, (advantage -
easier to sort by freqs), have to specify bound of players

note: 2 and 3 are similar in effect, mostly the difference is in how you are able to search through data you need to decide which method of storing data is best for each bot depending on what it does beware using modified perm get/setTag if bot is in an arena for long periods of time, data is not reset so the linkedlist could get huge
 
Initialize these following values in '''spawn.h''' at the very top: 
1.) '''Built in get/setTag method''' 
<pre>
#define DMG_DEALT 0
#define DMG_TAKEN 1
</pre>
// in spawn.cpp initialize the values on arena-enter and player-enter 
<pre>
case EVENT_ArenaEnter:
{
...

_listnode <Player> *parse = playerlist->head;

while (parse) // do for all pilots in arena when bot enters
{
Player *p = parse->item; // get pilot

set_tag(p, DMG_DEALT, 0); // initialize to 0

set_tag(p, DMG_TAKEN, 0);

sendPrivate(p,"*watchdamage"); // optionally turn on player *watchdamage

parse = parse->next; // get next pilot
}
}
</pre>
<pre>
case EVENT_PlayerEntering:
{
set_tag(p, DMG_DEALT, 0); // initialize to 0

set_tag(p, DMG_TAKEN, 0);

sendPrivate(p,"*watchdamage");
}
</pre>
// then somewhere edit the tag values
<pre>
case EVENT_WatchDamage:
{
// sets tag for k (shooter) to be old value plus damage dealt currently
set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT) + damage);
}
</pre>
The following demonstrates how to retrieve the tag values as a command in spawn.h.
<pre>
if (c->check("showstats")) {
int temp = get_tag(p, DMG_TOTAL_DEALT);

String s = "You've done ";
s += temp;
s += " damage so far!";

sendPrivate(p,s);
}
</pre>
Destroy the tags when the player leaves arena.
<pre>
case EVENT_PlayerLeaving:
{
killTags(p);
}
</pre>

2.) '''Modified permanent get/setTag method''' 
// same as get/setTag with some modifications to the tag code, then can use tags exactly as above

// spawn.h, add char name[20]; into struct PlayerTag
<pre>
struct PlayerTag
{
Player *p;
char name[20];
int index;
int data;
};
</pre>
In spawn.cpp:
<pre>
case EVENT_PlayerLeaving:
{
Player *p = (Player*)event.p[0];

// killTags(p); // remove so tag not deleted on arena exit

...
</pre>
Locate in spawn.cpp and modify accordingly:
<pre>
int botInfo::get_tag(Player *p, int index)
{
_listnode <PlayerTag> *parse = taglist.head;
PlayerTag *tag;

while (parse)
{
tag = parse->item;

// if (tag->p == p)
if (strcmp(tag->name,p->name)==0) // now tracking by player name, not ID
if (tag->index == index)
return tag->data;

parse = parse->next;
}
return 0;
}
</pre>
<pre>
void botInfo::set_tag(Player *p, int index, int data)
{
_listnode <PlayerTag> *parse = taglist.head;
PlayerTag *tag;

while (parse)
{
tag = parse->item;

//if (tag->p == p)
if (strcmp(tag->name,p->name)==0) // now tracking by player name, not ID
if (tag->index == index)
{
tag->data = data;
return;
}
parse = parse->next;
}

tag = new PlayerTag;
// tag->p = p; // not tracking by ID anymore
strncpy(tag->name, p->name, 20); // tracking by player name
tag->index = index;
tag->data = data;
taglist.append(tag);
}
</pre>

3.) '''Using structs, implement in spawn.h:''' 
<pre>
class botInfo
{
struct freqdata
{
int kills;
int deaths;
};
...
};
</pre>
To make use of this structure, implement accordingly:
<pre>freqdata freqs[100]; // 100 of those structs</pre>
Access the data in spawn.cpp using
<pre>freqs[56].kills = 1;</pre>


==Output of data/messages==
An example of using normal strings to output data/messages.
<pre>
// does *arena X pilots left in game
// NOTE: variable temp needs to be defined with some value

String s = "*arena ";
s += temp;
s += " pilots left in the game.";

sendPublic(s);
</pre>
Or,
<pre>
//NOTE: this can be considered inefficient.

sendPublic("*arena " + (String)temp + " pilots left in the game");
</pre>

An example using sprintf to align/space data, where output data will be in this approximate format.
<pre>
// output data will be in this approximate format (not lined up perfectly because of html)
// --------------------------------------------------------------------------------------
// Squad: squadname PTS FPTS K D DMG DEALT TAKEN F FK FLT
// --------------------------------------------------------------------------------------
// PlayerA 10000 500 116 101 9999 99999 10 150 980:55
// PlayerB 500 200 7 5 9999 99999 5 3 0:04

char str[255];
sendPublic("*arena--------------------------------------------------------------------------------");

sprintf(str, "*arena Squad: %-20s PTS FPTS K D DMG DEALT TAKEN F FK FLT",
freqs[freq].freqname
);

sendPublic(str);

sendPublic("*arena--------------------------------------------------------------------------------");

// assuming existing freqs struct with data
for (pilot=freqs[freq].playercount-1; pilot>=0; pilot--)
{
// on freq squad so print stats
char outString[255];

sprintf(outString, "*arena %-20s %12d %8d %3d %3d %10d %6d %2d %3d %3d:%02d",
freqs[freq].pilots[pilot].name,
freqs[freq].pilots[pilot].points,
freqs[freq].pilots[pilot].flagpoints,
freqs[freq].pilots[pilot].kills,
freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].dmgdealt,
freqs[freq].pilots[pilot].dmgtaken,
freqs[freq].pilots[pilot].flags,
freqs[freq].pilots[pilot].flagkills,
freqs[freq].pilots[pilot].flagtime /60,
freqs[freq].pilots[pilot].flagtime %60
);

sendPublic(outString);
}

// Notes: sprintf format = sprintf(output char string, spacing, variables)
// Notes: s = chars, d = integer, - = left align, right align default
// Notes: doing %02d = put 0 in front if not 2 digits, %3d:%02d makes 0:04 format
</pre>

==Input/Output to files==
For reading and/or writing to files with C++ you must have the required include

statement as follows:
#include <fstream>
using namespace std; // not a good practice, but works.

'''Note''': neither example shows how to properly handle possible

error-exceptions.

===Input to file===
The following example will show you how to read a file, duel.ini, line by line.

#include "stdlib.h" // for atoi()

<pre>
ifstream file("duel.ini");
char line[256];

// read in MaxBoxes=X
while (file.getline(line, 256))
{

if (CMPSTART("MaxBoxes=", line)) //Does the line begin with MaxBoxes= ?
{
MAX_BOXES = atoi(&(line[9])); //If so, read the value into an integer, using atio.
break;
}
}

file.close();
</pre>

===Output to file===
The following code example will demonstrate how to append to a file,

duelleaguestat.inc.

ofstream file("duelleaguestat.inc", ios::app); // app = put all data at end of file
file << squad1<< endl; // squad1 = char[20]
file << " vs "<< endl;
file << squad2<< endl; // squad2 = char[20]
file.close();

Similarly, you are able to write an output of a String to a file, which is

similar to the previous example but rather do this:

// key is converting String to (char*) to file write
String str = freqs[freq].slotname[slot];
str += ", Repels: " + (String)(int) t->repel;
file << endl;
file << (char*) str;

===Practical I/O Example===
This next example will show how to read input from a file using

"GetPrivateProfileString"; based on the rampage plugin.

The file format for rampage.ini is like this:
7=is on a killing spree! (6:0)
10=is opening a can of booya! (9:0)

Now to read input data,we begin by creating a '''rampageini.h''':
<pre>
#pragma once

#ifndef RAMPAGEINI_H

#define RAMPAGEINI_H
#define NUM_RANKS 10
#define BUFFER_LEN 256

struct RampageSettings
{
char quotes[NUM_RANKS][BUFFER_LEN];
};

void LoadSettings(RampageSettings &setts);

#endif
</pre>
In '''rampageini.cpp''':
<pre>
#include "rampageini.h"
static char buffer[BUFFER_LEN];
static char path[BUFFER_LEN];
#include "../algorithms.h"
#define WIN32_LEAN_AND_MEAN
#include <windows.h>

char *rank_type[10] = {
"7",
"10",
};

void LoadSettings(RampageSettings &setts)
{
GetCurrentDirectory(BUFFER_LEN - 64, path);
strcat(path, "\rampage.ini");

for (int i = 0; i < NUM_RANKS; ++i)
{
GetPrivateProfileString("Comments", rank_type[i], "-ERROR-",
setts.quotes[i], BUFFER_LEN, path);
}
}
</pre>

==Useful Player data==
As stated earlier in the tutorial, MervBot stores useful player data internally as Player objects, see player.h for implementation details.

* p->name = player name stored as char[20]
** '''Note:''' SubSpace protocol allows for usernames to be 19+ in length, do not rely on this for player-name comparisions.
* p->squad = player squad stored as char[20]
* p->ship = ship (0-9) enumerated as SHIP_Warbird, SHIP_Spectator, etc..
* p->safety = if ship is in safety zone (boolean)
* p->bounty = player bounty
* p->energy = player energy (have bot with *energy on to get accurate readings)
* p->flagCount = how many flags player is holding
* p->team = player frequency
* p->(burst, repel, thor, brick, decoy, rocket, portal) = how many items of that type player has
* p->(stealth, cloak, xradar, awarp, ufo, flash, safety, shields, supers) = if player has that item on (boolean)
* p->score.killPoints = player kill points
* p->score.flagPoints = player flag points
* p->score.wins = player kills from f2
* p->score.losses = player deaths from f2


==Bot built in functions==
<blockquote>// useful MervBot commands to control what the bot is doing 
 
// player.cpp 
Player::move(Sint32 x, Sint32 y)  // example  me->move(512,512) - bot moves to coord 512 512 
Player::clone(Player *p) // example  me->clone(p) 
 
// dllcore.cpp (descriptions of functions in dllcore.h) 
 
BotEvent makeEcho                (char *m); 
BotEvent makeSay                (int t, int s, int i, char *m); 
 
BotEvent makeShip                (int s); 
BotEvent makeTeam                (int t); 
BotEvent makeGrabFlag            (int f); 
BotEvent makeSendPosition        (bool reliable); 
BotEvent makeDropFlags            (); 
 
BotEvent makeDeath                (Player *p); 
BotEvent makeAttach                (Player *p); 
BotEvent makeDetach                (); 
BotEvent makeFollowing            (bool f); 
BotEvent makeFlying                (bool f); 
BotEvent makeBanner                (BYTE *b); 
BotEvent makeDropBrick            (); 
BotEvent makeFireWeapon            (void *weapon_info); 
 
BotEvent makeToggleObjects        (Uint16 player, Uint16 *objects, int num_objects); 
 
BotEvent makeSpawnBot           
(char *name, char *password, char *staff, char *arena); 
BotEvent makeChangeArena        (char *name); 
BotEvent makeChangeSettings        (_linkedlist <String> *settings); 
 
// example how to use them: 
 
tell(makeFollowing(false)); 
 
// look in Commands.txt , command.cpp (core), or /!help to bot to see all bot external commands (example /!go <arena>) 
</blockquote>

==Example Code==




 -->

 -->
==== No antiwarp in center of the map ====

'''Example A''': No antiwarp in center of map. Warn the player, and revoke the prize.
In order for this code to work correctly, the bot must have smod+ privilages.
Lets first implement two functions which we will need to accomplish this task:
<pre>
bool closeto(Player *p, int x, int y, int tolerance) {
return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); }

inline int abs(int n) {
if (n < 0) return -n;
else return n; }
</pre>

We should define the radius of antiwarp checking, this can be done several ways, for sake of simplicity, here is a quick-plop-in for '''spawn.h''':
<pre>
class botInfo
{
bool CONNECTION_DENIED;
...
// Put bot data here
int radius;

public:
botInfo(CALL_HANDLE given)
{
...
// Put initial values here
radius = 35;
...
</pre>
Locate and add into '''spawn.cpp''' accordingly:
<pre>
case EVENT_PlayerMove:
{

Player *p = (Player*)event.p[0];

// no anti in center
if ((p->ship != SHIP_Spectator) && (p->awarp)) {
if (closeto(p, 512, 512, radius)){
sendPrivate(p, "*prize #-20");
sendPrivate(p, "*warn Antiwarp is not allowed in center.");
}
}
...
</pre>
Just as a word of caution, players may at times be flooded with *prize #-20, and *warn statements under certain conditions.

 
==== Setting freq size depending on how many pilots in game ====

'''Example B''': Setting freq size depending on how many pilots in game.
In order for this code to work correctly, the bot must have Sysop or Arena-Owner privilages.
In '''spawn.cpp''' (Note: this source code has assumptions, please review comments before implementing.):
<pre>
case EVENT_Tick:
{
...

// NOTE: assuming countdown[0] initialized to > 0 in spawn.h, freqchange=0;
if (countdown[0] == 0)
{
_listnode <Player> *parse = playerlist->head;
int count = 0;

while (parse)
{
Player *p = parse->item;

if (p->ship != SHIP_Spectator)
++count;

parse = parse->next;
}

if ((count > 24) && (freqchange != 4))
{
sendPublic("?set team:maxperteam:4"); //Sysop command to modify arena config.
String s;
s = "Max freq size 4 (";
s += count;
s += " pilots in game)";
sendPublic(s);
freqchange = 4;
}

if ((count < 25) && (count > 14) && (freqchange != 3))
{
sendPublic("?set team:maxperteam:3"); //Sysop command to modify arena config.
String s;
s = "Max freq size 3 (";
s += count;
s += " pilots in game)";
sendPublic(s);
freqchange = 3;
}

countdown[0] = 120; // reset timer to 120 seconds.
}
</pre> 
==== Tracking kills and announcing when pilot gets 10 kills in a row without dying ====

'''Example C''': Tracking kills and announcing when pilot gets 10 kills in a row without
dying.
In order for this code to work correctly, the bot must have smod+ privilages.
Locate EVENT_PlayerDeath in '''spawn.cpp''' (see note.):
<pre>
EVENT_PlayerDeath:
{
Player *p = (Player*)event.p[0],
*k = (Player*)event.p[1];
Uint16 bounty = (Uint16)(Uint32)event.p[2];
Uint16 flags = (Uint16)event.p[3];

// NOTE: assuming tags are setup (see storing data section).
set_tag(p, KILLS, 0); // pilot died, reset to 0 kills in a row
set_tag(k, KILLS, get_tag(k, KILLS) + 1); // pilot killed someone, increment kills in a row by 1

if (get_tag(k, KILLS) == 10)
sendPublic("*arena (String) k->name + " has gotten 10 kills.");
...
}
</pre>
 
==== Warp pilot to coord when they are in a certain region ====

'''Example D''': Warp pilot to coord when they are in a certain region.
In order for this code to work correctly, the bot must have smod+ privilages.
Lets first implement two functions which we will need to accomplish this task:
<pre>
bool closeto(Player *p, int x, int y, int tolerance) {
return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); }

inline int abs(int n) {
if (n < 0) return -n;
else return n; }
</pre>

In '''spawn.cpp''', EVENT_PlayerMove:
<pre>
case EVENT_PlayerMove:
{
Player *p = (Player*)event.p[0];

if (closeto(p, 509, 509, 2)) // if pilot within 2 of map coord 509,509
{
sendPrivate(p, "*warpto 509 504"); // warp to coord 509,504
}
...
</pre>
 
==== Structures within structures ====

'''Example E''': Structures within structures (spawn.h botinfo).
Implement the following in the spawn.h:
<pre>
struct playerstats
{
char name[20];

int kills;
int deaths;
Uint16 points;
Uint16 flagpoints;
int flagtime;
int cflagtime;
int flags;
int flagkills;

int dmgdealt;
int dmgtaken;
};

struct freqdata
{
playerstats pilots[100];

int freqpoints;
char freqname[20];
int freqflagpoints;
Uint16 freqteam;
int freqflagtime;

int flags;
int kills;
int deaths;
int flagkills;

int dmgdealt;
int dmgtaken;

int playercount;
};

//... (large jump down in spawn.h)

// Put bot data here <- locate and add after:
freqdata freqs[100];

//... <- perhaps some other variables.. scroll down past the next }
}

void Clear(); // A user-defined function. Add this.

void clear_objects(); //already exists, provided by Catid.
void object_target(Player *p); //already exists, provided by Catid.

// ... spawn.h continues.
</pre>

Implement the following in '''spawn.cpp''':
<pre>
void botInfo::Clear()
{
// initialize/clear struct data
for (int n=99; n>=0; n--)
{
freqs[n].freqteam=-1;
freqs[n].freqpoints=0;
freqs[n].freqflagpoints=0;
freqs[n].playercount=0;
freqs[n].flags=0;
freqs[n].kills=0;
freqs[n].deaths=0;
freqs[n].freqflagtime=0;
freqs[n].flagkills=0;
freqs[n].dmgdealt=0;
freqs[n].dmgtaken=0;

for (int m = 99; m>=0; m--)
{
freqs[n].pilots[m].deaths=0;
freqs[n].pilots[m].kills=0;
freqs[n].pilots[m].points=0;
freqs[n].pilots[m].flagpoints=0;
freqs[n].pilots[m].flagtime=0;
freqs[n].pilots[m].cflagtime=0;
freqs[n].pilots[m].flags=0;
freqs[n].pilots[m].flagkills=0;
freqs[n].pilots[m].dmgdealt=0;
freqs[n].pilots[m].dmgtaken=0;
}
}
}
</pre>

To access private data:
<pre>freqs[1].pilots[2].kills++;</pre>
-OR-
<pre>int freq = p->team;
freqs[freq].deaths++;</pre>
 
==== Tracking flag data ====

'''Example F''': Tracking flag data.
f) Tracking flag data 

<blockquote>Example GetPilot() function  (using structs from example e) <blockquote>bool botInfo::GetPilot(Player *p) 
{ 
    // get a pilots freq/pilot id from struct 
    for (freq=freqcount-1; freq>=0; freq--) 
if (p->team == freqs[freq].freqteam) 
    for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--) 
       
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0) 
            return true; 
    return false; 
} 
</blockquote></blockquote>
 
<blockquote>Example way to track flag data using above struct/functions <blockquote>
case EVENT_FlagGrab: 
{ 
    if (GetPilot(p))  // function 
    { 
        freqs[freq].pilots[pilot].flags++; 
        freqs[freq].flags++; 
       
if (freqs[freq].pilots[pilot].flags < 2) // didnt have a flag before,
first flag 
       
    freqs[freq].pilots[pilot].cflagtime = GetTickCount();
 // time stamp when picked up flag 
    } </blockquote></blockquote>
 <blockquote>Example way to track flag data using built in get/set tag (from catid flagbot) 

<blockquote>
case EVENT_FlagGrab: 

{ 

    set_tag(p, TAG_STAT_FS, get_tag(p, TAG_STAT_FS) + 1); 

    set_tag(p, TAG_FLAGTIMER, GetTickCount()); 

} 

</blockquote> </blockquote> <blockquote>Get current flag times using struct format 

<blockquote>void botInfo::SetFlagTimes() 
{ 
    // set current flagtime for pilots/freqs 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
Player *p = parse->item; 

 
if (GetPilot(p)) 
    if (freqs[freq].pilots[pilot].flags > 0) 
    { 
        if (PilotOnSquad(p)) 
       
    freqs[freq].freqflagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000; 

 
       
freqs[freq].pilots[pilot].flagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000; 
       
freqs[freq].pilots[pilot].cflagtime = GetTickCount(); 
    } 

 
parse = parse->next; 
    } 
} 

</blockquote>
// side note:  case EVENT_FlagDrop: {} gets called anytime theres a teamkill 

</blockquote>
 
==== Example way to do simple /!spam feature (allowed 1x/60s) ====

'''Example G''': Example way to do simple /!spam feature (allowed 1x/60s).
g) Example way to do simple /!spam feature (allowed 1x/60s) 

<blockquote>declare and initialize variables in spawn.h 

<blockquote>class botInfo 
{ 
bool spamready; 
int SPAM_TIME; 

 
public: 
    botInfo(CALL_HANDLE given) 
    { 
    spamready = true; 
    SPAM_TIME = 60; 

</blockquote>
spawn.cpp - mark as spamready=true when 60 seconds up 

<blockquote>case EVENT_Tick: 
{ 
    if (countdown[0] == 1)  { 
        spamready = true;  // ready to spam again 
    } 

</blockquote>

 
command.cpp - handle !spam command 

<blockquote>case OP_Player: 
{    // Player-level commands 

 
else if (c->check("spam")) 
    { 
       
// zone announcement "Need pilots to duel in ?go arena -pilotname" 
        if (spamready == true) 
            { 
            String s; 
       
    s += "*zone Need pilots to duel in ?go "; 
            s += arena; 
            s += " - "; 
            s += p->name; 
            sendPublic(s); 
          
            spamready=false; 
       
    countdown[0] = SPAM_TIME * 60; // next spam time limit 
            } 
        else if (countdown[0] < 0) 
        { 
       
    sendPrivate(p,"Spam ability disabled."); 
        } 
        else 
            { 
            String s; 
            s += SPAM_TIME; 
       
    s += " Minute timer between announcements. "; 
            s += countdown[0] / 60; 
            s += ":"; 
            if (countdown[0] % 60 < 10) 
                s += "0"; 
            s += countdown[0] % 60; 
       
    s += " minutes left before next spam allowed."; 
            sendPrivate(p, s); 
            } 
    } 

</blockquote> </blockquote>
 
==== Implementing a simple stack to do "next in line for several 'boxes' at once" ====

'''Example H''': Example of implementing a simple stack to do "next in line for several 'boxes' at once".
In '''spawn.h''' declare the following variables and structs:
<pre>
class botInfo
{
//...

// Put bot data here <- locate and add after
Player *next[99][99];
int MAX_NEXT;
int nextcount[99];

public:
botInfo(CALL_HANDLE given)
{
//...

// Put initial values here <- locate and add after
MAX_NEXT = 8;

//... spawn.h continues on.
</pre>
In '''spawn.cpp''' implement (remember to add the function prototype to spawn.h as well.):
<pre>
void botInfo::MoveUp(int pos, int box)
{
// moves up the next line for that box and decrement box's nextcount
if (nextcount[box] > 0)
nextcount[box]--;

for (pos = pos; pos < MAX_NEXT - 1; pos++)
{
next[box][pos] = next[box][pos + 1];
}

next[box][MAX_NEXT] = 0;
}
</pre>

 

==== Example of reading any text from a .txt and printing it to pilot line by line ====

'''Example I''': Example of reading any text from a .txt and printing it to pilot line by line.
Required include:
<pre>#include <fstream>
using namespace std; // bad coding practice, but for ease of use, we'll use it.
</pre>
Example of use, in command.cpp:
<pre>
case OP_Player:
{
//...

if (c->check("staff"))
{
// read in data line by line from the file staff.txt (max length 255)
ifstream file("staff.txt");
char line[256];

while (file.getline(line, 256))
{
sendPrivate(p, line);
}
file.close();
}

//... command.cpp continues.
</pre>

 

==== Example of printing player stats grid ====

'''Example J''': Example of printing player stats grid.
'''Note''': This example code relies on previously discussed material. Please see the section "structures within structures" example for variable declarations, varibale freqcount = # of freqs.
'''Note''': User defined function ''sendFreqs'' is required.
In '''spawn.cpp''':
<pre>
void botInfo::DisplayPlayers()
{
// Display Match player/freq stats in this format
// ---------------------------------------------------
// Squad: squad_name_1 K D TK DMG DEALT TAKEN
// ---------------------------------------------------
// Player_1 0 0 0 0 0
// Player_2 0 0 0 0 0
// TOTAL: 0 0 0 0 0
// ---------------------------------------------------
// Squad: squad_name_2 K D TK DMG DEALT TAKEN
// ---------------------------------------------------
// Player_3 0 0 0 0 0
// Player_4 0 0 0 0 0
// Player_5 0 0 0 0 0
// TOTAL: 0 0 0 0 0
// ---------------------------------------------------

for (freq=freqcount-1; freq>=0; freq--)
{
char str[255];

sendFreqs("---------------------------------------------------");

sprintf(str, "Squad: %-20s K D TK DMG DEALT TAKEN", freqs[freq].freqname);

sendFreqs(str);

sendFreqs("---------------------------------------------------");

for (pilot=freqs[freq].playercount-1; pilot >= 0; pilot--)
{
sprintf(str, "%-20s %8d %2d %2d %9d %5d",
freqs[freq].pilots[pilot].name,
freqs[freq].pilots[pilot].kills,
freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].teamkills,
freqs[freq].pilots[pilot].dmgdealt,
freqs[freq].pilots[pilot].dmgtaken
);
sendFreqs(str);
}

sprintf(str, "TOTAL: %2d %2d %2d %9d %5d",
freqs[freq].kills, freqs[freq].deaths,
freqs[freq].teamkills,
freqs[freq].dmgdealt,
freqs[freq].dmgtaken
);
sendFreqs(str);
}

sendFreqs("---------------------------------------------------");
}
</pre>

 

==== Checking if any pilots are within a region ====

'''Example K''': Example of checking if any pilots are within a region.
'''Note''': User-defined function ''GetPilotName'' is missing, and needs to be implemented.See prior examples.
'''Note''': User-defined function ''closeto'' is missing, and needs to be implemented. See prior examples.
In spawn.cpp ('''Note''': you will also need to add the function prototype to spawn.h accordingly):
<pre>
bool botInfo::FreqAInBox()
{
// return true if teamA has a pilot in the box, otherwise false
for (int tempplayercount = freqs[0].playercount-1; tempplayercount >= 0; tempplayercount--)
if (GetPilotName(freqs[0].pilots[tempplayercount].name))
if (closeto(TempPlayer, coordX, coordY, 73) && (TempPlayer->ship != SHIP_Spectator))
return true;

return false;
}
</pre>

 

==== Functions to get a pilot's struct id info from a name or *player info ====

'''Example L''': Example of functions to get a pilot's struct id info from a name or *player info.
'''Note''': Required structures needed for this example to work. See structure examples for variable information.
'''Note''': Remember to implement any function into the spawn.h accordingly.
'''Note''': Using pilot names as vital comparisions should be used with caution. See [http://cypherjf.sscentral.com/articles/botsasclients.html Bot-Issues] by CypherJF.
'''Note''' from Underlord: It is "better to implement these functions as passing values by reference instead of using global variables... [it is] just easier to not have to be declaring different int freq, int pilot all the time."
In spawn.cpp:
<pre>
// return struct freq/pilot id from *player info
bool botInfo::GetPilot(Player *p)
{
// return freq, pilot of a player p
for (freq=freqcount-1; freq>=0; freq--)
if (p->team == freqs[freq].freqteam)
for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--)
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0)
return true;

return false;
}
</pre>
<pre>
// return *player as TempPlayer info from p->name info
bool botInfo::GetPilotName(char *name)
{
// get pilot from a name, return as TempPlayer
_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

// convert both to lowercase to compare
char pname[20];
strncpy(pname,p->name,20);

char nname[20];
strncpy(nname,name,20);

tolower(pname);
tolower(nname);

if (strcmp(pname,nname)==0)
{
TempPlayer = p;
return true;
}

parse = parse->next;
}
return false;
}
</pre>

 

==== Creating a logfile name using date and squad names ====

'''Example M''': Example of creating a logfile name using date and squad names.
Example Output: 03y01m27dBLACKDRaGON vs Integral05h08m.txt.
Format: year, month, day, squadA vs squadB, hour, minute.
'''Note''': Assuming you define the following variables: squadA (String), squadB (String).

<pre>
// create log file name (squadA and squadB external char[20] variables)
char u[100];
time_t t=time(NULL);
tm *tmp = localtime(&t);
strftime(u,99,"%y",tmp);
logname = u;
logname += "y";
strftime(u,99,"%m",tmp);
logname += u;
logname += "m";
strftime(u,99,"%d",tmp);
logname += u;
logname += "d";
logname += squadA;
logname += " vs ";
logname += squadB;
strftime(u,99,"%I",tmp);
logname += u;
logname += "h";
strftime(u,99,"%M",tmp);
logname += u;
logname += "m";
logname += ".txt";
</pre>

 

==== Sending messages to playing freqs or public and logging depending on status ====

'''Example N''': Example of sending messages to playing freqs or public and logging depending on status.
'''Note''': Assumes you have the following variables declared: teamA (String), teamB (String), logname (String).
'''Note''': Remember to implement the function prototypes into spawn.h
Required include statements:
<pre>
#include <fstream>
using namespace std; // bad coding practice, but it works.
</pre>

In spawn.cpp:
<pre>
// teamA, teamB, logname global variables
void botInfo::sendFreqs(char *msg)
{
char *mmsg = "*arena";
String s = msg;

if (teammsgs == false)
{
s.prepend("*arena ",7);
sendPublic(s);
}
else
{
sendTeamPrivate(8025,msg);
sendTeamPrivate(teamA,msg);
sendTeamPrivate(teamB,msg);
}
if (gameon == true)
{
ofstream outf(logname, ios::app);
outf << msg << endl;
outf.close();
}
}
</pre>

 

==== Reading in all player/freqs to struct data ====

'''Example O''': Example of reading in all player/freqs to struct data.
o) Example of reading in all player/freqs to struct data 

<blockquote>// see structures within structures example for freqs[] declaration 

 
// to get freqs in a game where there are several freqs 
void botInfo::GetFreqs() 
{ 
    // read pilots into freq struct data from ingame and on playing freqs 

 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
Player *p = parse->item; 

 
if (p->ship != SHIP_Spectator) 
    if (closeto(p, coordX, coordY, 73)) 
    { 
        // look for freq in struct 
        bool foundfreq=false; 

 
        freq=freqcount-1; 

 
        while ((freq>=0) && (foundfreq==false)) 
        { 
       
    if (p->team == freqs[freq].freqteam) 
            { 
       
foundfreq=true; 
       
strncpy(freqs[freq].pilots[freqs[freq].playercount].name,
p->name, 20); 
       
freqs[freq].playercount++;   
 
            } 
            freq--; 
        } 

 
        // didnt find freq in struct so add new freq 
        if (foundfreq == false) 
        { 
            if (manualsquads == false) 
            { 
       
strncpy(freqs[freqcount].freqname,
p->squad, 20); 

 
       
if (freqcount == 0) 
                { 
       
    teamA = p->team; 
       
    strncpy(squadA,
p->squad, 20); 
                } 
                else 
                { 
       
    teamB = p->team; 
       
    strncpy(squadB,
p->squad, 20); 
                } 
            } 
            else 
            { 
       
if (p->team == teamA) 
       
    strncpy(freqs[freqcount].freqname,squadA,20); 

 
       
else if (p->team == teamB) 
       
    strncpy(freqs[freqcount].freqname,squadB,20); 
            } 
            
       
    freqs[freqcount].freqteam = p->team; 

 
       
    strncpy(freqs[freqcount].pilots[0].name, p->name, 20); 
               
       

 
            freqs[freqcount].playercount++; 
            freqcount++; 
        } 
    } 
parse = parse->next; 
    } 
} 

 
// to get freqs in a game where there are only two teams 
void botInfo::GetFreqs() 
{ 
    // read pilots into freq struct data from ingame and on playing freqs 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
Player *p = parse->item; 

 
if ((p->ship != SHIP_Spectator)
&& ((p->team == teamA) || (p->team == teamB))) 
{ 
    // freq 100, team A 
    // set freq 
    freq = 0; 

 
    if (p->team == teamB) 
        freq = 1; 

 
    // number of pilots on freq counted so far, starts 0 
    pilot = freqs[freq].playercount; 

 
    // pilot name 
    strncpy(freqs[freq].pilots[pilot].name, p->name, 20); 
    // time stamp for playing time 
    freqs[freq].pilots[pilot].cplaying_time = GetTickCount(); 

 
    // slot name 
    if (freqs[freq].playercount < NUMBER_PILOTS) 
       
strncpy(freqs[freq].slotname[pilot], p->name, 20); 
 
    // increment freq player count 
    freqs[freq].playercount++; 

 
    // if freq not already have name, give it player squad name 
    if ((manualsquads == false) && (strlen(p->squad) > 0)) 
        strncpy(freqs[freq].freqname, p->squad, 20); 

 
            // set player ship 
    freqs[freq].pilots[pilot].ship = p->ship + 1; 
} 
parse = parse->next; 
    } 
} 

</blockquote>
 
==== Finding MVP from struct data (2*kills - deaths formula) ====

'''Example P''': Example of finding MVP from struct data (2*kills - deaths formula).

<pre>
int highest = -20;
int mvp = 0;

for (pilot = freqs[mvpteam].playercount-1; pilot >=0; pilot--)
{
if (((freqs[mvpteam].pilots[pilot].kills * 2) - freqs[mvpteam].pilots[pilot].deaths) > highest)
{
mvp = pilot;
highest = (freqs[mvpteam].pilots[pilot].kills * 2) - freqs[mvpteam].pilots[pilot].deaths;
}
}
</pre>

 
==== Print time stamp of event ====

'''Example Q''': Print time stamp of event.
<pre>#include "time.h" // required include</pre>Use:
<pre>
char u[100];
time_t t=time(NULL);
tm *tmp = localtime(&t);
strftime(u,99,"%c",tmp);
sendPublic("Current date and time: " + (String) u);
</pre>
 
==== Simple way to track player bomb/bullet damage stats ====

'''Example R''': Simple way to track player bomb/bullet damage stats.
'''Note''': see data section for how to setup set_tag.
'''Note''': see clientprot.h for weapon information.
In '''spawn.cpp''':
<pre>
case EVENT_WatchDamage:
{
if (PLAYING) // if tracking stats
{
if ((wi.type == PROJ_PBomb) && (p->name != k->name))
{
set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT) + damage);
set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT) + damage);
set_tag(p, DMG_BOMB_TAKEN, get_tag(p, DMG_BOMB_TAKEN) + damage);
set_tag(p, DMG_TOTAL_TAKEN, get_tag(p, DMG_TOTAL_TAKEN) + damage);
}
else if (wi.type == PROJ_BBullet)
{
set_tag(k, DMG_BULLET_DEALT, get_tag(k, DMG_BULLET_DEALT) + damage);
set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT) + damage);
set_tag(p, DMG_BULLET_TAKEN, get_tag(k, DMG_BULLET_TAKEN) + damage);
set_tag(p, DMG_TOTAL_TAKEN, get_tag(k, DMG_TOTAL_TAKEN) + damage);
}
}
</pre> 

==== Simple way to print those stats ====

'''Example S''': Simple way to print those stats.
<pre>
case OP_Moderator:
{
if (c->check("showstats"))
{
sendPublic("Showing stats:");

_listnode <Player> *parse = playerlist->head;

while (parse)
{
Player *p = parse->item;

if (get_tag(p, DMG_TOTAL_DEALT) > 0)
{
char str[256];
sprintf(str, "(%-20s Dmg Dealt: Total %0004d, Bomb %0004d, Bullet %0004d Dmg TAKEN: Total %0004d, Bomb %0004d, Bullet %0004d)",
p->name,
get_tag(p,DMG_TOTAL_DEALT),
get_tag(p,DMG_BOMB_DEALT),
get_tag(p,DMG_BULLET_DEALT),
get_tag(p,DMG_TOTAL_TAKEN),
get_tag(p,DMG_BOMB_TAKEN),
get_tag(p,DMG_BULLET_TAKEN)
);

sendPublic(str);
}
parse = parse->next;
}
}
}
</pre> 


==== Make bot spectate specific coordinates ====

'''Example T''': Make bot spectate specific coordinates.

<pre>
// make bot spectate the coord 512,600
// possible use - capturing weapon packets in a specific region

tell(makeFollowing(false));
tell(makeFlying(true));
me->move(512 * 16, 600 * 16);
tell(makeSendPosition(true));
</pre>

Talk:MERVBot Tutorial

2005-02-15T05:39:19Z

D1st0rt: gah im tired, forgot name

D1s: Anybody wanna format this int a table of contents? I'm lazy

[[User:Smong|Smong]]: That is sick. Maybe split into more pages? Says it is over 160k.

[[User:Pests|Pests]]: There is already pages defined. You could just split them up into that.

OK, I'm working on converting it to real HTML (using <pre>) instead of the &nbsp; crap. --[[User:Cyan~Fire|Cyan~Fire]]

[[User:CypherJF|CypherJF]]: Should we just call this "the bot tutorial" based on the tutorial by Underlord? Then update it accordingly? -- And also, the link to MervBot w/e 37 is now 45; should we just comment that this tutorial was writen for the 37 -- or... comments! lol.

== sscanf ==

Well, I'm using sscanf() for parsing player input. Yes, an advanced function, but maybe it will discourage C++ newbs from making bot plugins. Any comments? --[[User:Cyan~Fire|Cyan~Fire]]

D1st0rt: Cool beans. I learned something new :D

== Event list ==

Removed event list because it was redundant with dllcore.h, less descriptive, and too easy to get out-of-date. Anybody who wants it back, please post here so I can ignore you. :-D --[[User:Cyan~Fire|Cyan~Fire]]

[[User:CypherJF|CypherJF]]: Like people are really going to read through the dllcore.h file.. on a webpage tutorial. hmm i think not. I still say keep it there.

If someone doesn't make the effort to look up events in dllcore.h, they shouldn't be making plugins. I think of this tutorial as more of a "here are the basics and intricacies of making a MERVBot plugin" more than "here is how to follow step-by-step instructions and call it programming". --[[User:Cyan~Fire|Cyan~Fire]]

D1s: Even ''I'' look up things in dllcore.h, its a very useful resource. As long as it says to look in it, I don't think we'd need the full list here

== Extra Code Samples ==
[[User:CypherJF|CypherJF]]: I'd like to somehow split these up better; and make them linkable, what do you guy's think?

[[User:CypherJF|CypherJF]]: I made sub-headers, and so they'll be added into the table of contents. Let me know what you guys think of it.

Alrighty, looks good. One thing I would ask is to try to save up a bunch of edits in a text editor or something, than have the myriad edits you do now. Thanks for sharing the burden with me! --[[User:Cyan~Fire|Cyan~Fire]]

Talk:MERVBot Tutorial

2005-02-15T05:38:16Z

D1st0rt: /* Event list */

D1s: Anybody wanna format this int a table of contents? I'm lazy

[[User:Smong|Smong]]: That is sick. Maybe split into more pages? Says it is over 160k.

[[User:Pests|Pests]]: There is already pages defined. You could just split them up into that.

OK, I'm working on converting it to real HTML (using <pre>) instead of the &nbsp; crap. --[[User:Cyan~Fire|Cyan~Fire]]

[[User:CypherJF|CypherJF]]: Should we just call this "the bot tutorial" based on the tutorial by Underlord? Then update it accordingly? -- And also, the link to MervBot w/e 37 is now 45; should we just comment that this tutorial was writen for the 37 -- or... comments! lol.

== sscanf ==

Well, I'm using sscanf() for parsing player input. Yes, an advanced function, but maybe it will discourage C++ newbs from making bot plugins. Any comments? --[[User:Cyan~Fire|Cyan~Fire]]

D1st0rt: Cool beans. I learned something new :D

== Event list ==

Removed event list because it was redundant with dllcore.h, less descriptive, and too easy to get out-of-date. Anybody who wants it back, please post here so I can ignore you. :-D --[[User:Cyan~Fire|Cyan~Fire]]

[[User:CypherJF|CypherJF]]: Like people are really going to read through the dllcore.h file.. on a webpage tutorial. hmm i think not. I still say keep it there.

If someone doesn't make the effort to look up events in dllcore.h, they shouldn't be making plugins. I think of this tutorial as more of a "here are the basics and intricacies of making a MERVBot plugin" more than "here is how to follow step-by-step instructions and call it programming". --[[User:Cyan~Fire|Cyan~Fire]]

Even ''I'' look up things in dllcore.h

== Extra Code Samples ==
[[User:CypherJF|CypherJF]]: I'd like to somehow split these up better; and make them linkable, what do you guy's think?

[[User:CypherJF|CypherJF]]: I made sub-headers, and so they'll be added into the table of contents. Let me know what you guys think of it.

Alrighty, looks good. One thing I would ask is to try to save up a bunch of edits in a text editor or something, than have the myriad edits you do now. Thanks for sharing the burden with me! --[[User:Cyan~Fire|Cyan~Fire]]

MERVBot Tutorial

2005-02-14T01:50:52Z

D1st0rt: countdowns with #define

Here is the ever-popular MERVBot Tutorial by Underlord:

<div id="merv_toc" style="font-size: 12px; margin: 2em;">
Setup a MERVBot bot and project in visual c++ 
0) <a href="#0">Setting up a MERVBot bot</a> 
 
Command.cpp 
 1) <a href="#1">Player commands</a> (!play, !squadA vs squadB) 
 
Spawn.cpp 
 2) <a href="#2">Event descriptions</a> (describe events in spawn.cpp) 
 2) <a href="#2">Messaging </a>("*arena hi", ":player:*scorereset) 
 3) <a href="#3">MervBot Timer</a> (do this in 10 seconds)(countdown[n]) 
 4) <a href="#4">Writing Functions</a> (bool IsInCenter(Player *p)) 
 
Useful operations 
 6) <a href="#6">Cycling players</a> 
 7) <a href="#7">Check if pilot is in safe zone</a> 
 8) <a href="#8">Random numbers</a> 
 9) <a href="#9">Time without using countdown[n]</a> 
10) <a href="#10">Storing data for pilots</a> 
11) <a href="#11">Output data in messages</a> 
12) <a href="#12">Input/Output to files</a> 
13) <a href="#13">Programming commands</a> 
14) <a href="#14">Useful player data</a> 
15) <a href="#15">Bot built in functions</a> 
 
Example Code 
<div style="margin-left: 2em">
a) <a href="#15a">No antiwarp in center of map</a> 
b) <a href="#15b">Setting freq size depending on how many pilots in game</a> 
c) <a href="#15c">Tracking kills and announcing when pilot gets 10 kills in a row without dying </a> 
d) <a href="#15d">Warp pilot to coord when they are in a certain region</a> 
e) <a href="#15e">Structures within structures</a> 
f) <a href="#15f">Tracking flag data</a> 
g) <a href="#15g">Way to do simple /!spam feature</a> 
h) <a href="#15h">Implementing a simple stack to do "next in line for several 'boxes' at once"</a> 
i) <a href="#15i">Reading any text from a .txt and printing it to pilot line by line</a> 
j) <a href="#15j">Example of printing player stats grid</a> 
k) <a href="#15k">Example of checking if any pilots are within a region</a> 
l) <a href="#15l">Example of functions to get a pilot's struct id info from a name or *player info</a> 
m) <a href="#15m">Example of creating a logfile name using date and squad names</a> 
n) <a href="#15n">Sending messages to playing freqs or public and logging depending on status</a> 
o) <a href="#15o">Example of reading in all player/freqs to struct data</a> 
p) <a href="#15p">Example of finding MVP from struct data</a> 
q) <a href="#15q">Print time stamp of event</a> 
r) <a href="#15r">Simple way to track player bomb/bullet damage stats</a> 
s) <a href="#15s">Simple way to print those stats</a> 
t) <a href="#15t">Make bot spectate specific coordinates</a>
</div>
</div>

==Setting up a MERVBot (plugin)==

MERVBot download site:  http://catid.sscentral.com/

MERVBot Forum:  http://www.ssforum.net/  (Development - MervBot forum)

===Download [http://catid.sscentral.com/files/MERVBot.zip MERVBot Build 37 (DLL 6.5)]===

Unzip MERVBot.zip into a new folder. (example c:\program files\continuum\mervbot) 
Unzip src.zip into "src" subfolder of that new folder (example c:\program files\continuum\mervbot\src)

===Download [http://catid.sscentral.com/files/Tutorial.zip DLL-plugin Tutorial]===

''Note:'' if you only want to execute someone's premade plugin (.dll), skip to [[MERVBot Tutorial#Run your bot dll|step 4]], otherwise continue to learn how to make your own bot

Unzip Tutorial.zip (containing spawn.h, spawn.cpp, and command.cpp) into "/tutorial" subfolder of that new folder. (example c:\program files\continuum\mervbot\src\tutorial).

''File descriptions:''
<ul>
<li>spawn.h = declare/initialize globals
<li>command.cpp = code for commands coming into bot (ie /!help, /!play, etc)
<li>spawn.cpp = code for main part of bot
</ul>

===Microsoft Visual c++===

<ol>
<li>Start Visual Studios 6.0.
<li>Click the Drop Down Menu labeled "File" at the top left of your screen.
<li>Click "New".
<li>On the next screen that comes up, choose from the Project tab, then Win32 Dynamic-Link Library
<li>Select the "/src" folder as the base folder (example c:\program files\continuum\mervbot\src)
<li>Name your project "mybot". This will make a "mybot" subfolder in your "src" folder. Click OK. (example creates c:\program files\continuum\mervbot\src\mybot)
<li>Choose to create an "Empty DLL project".
<li>Click "Finish".
<li>Click the Drop Down Menu labbled "Project".
<li>Click "Add To Project Files"
<li>Copy only spawn.h, spawn.cpp, and command.cpp from the "tutorial" folder into the this new folder. (example from c:\program files\continuum\mervbot\src\tutorial to c:\program files\continuum\mervbot\src\mybot)
<li>Click the Drop Down Menu labelled "Build".
<li>Click "Build (dll name)" - where (dll name) is "mybot"
<li>Go into your "mybot" folder and look for a folder named "Debug"
(example c:\program files\continuum\mervbot\src\mybot\debug)
<li>Your new DLL will be in that folder. (example mybot.dll)
<li>Copy mybot.dll to your base folder that has mervbot.exe in it (example c:\program files\continuum\mervbot)
</ol>

===Run your bot dll===

To run your bot you need your DLL (mybot.dll), Commands.txt, MERVBot.exe, MERVBot.ini, Operators.txt, Spawns.txt, subspace.bin, and zlib.dll all in one folder (example c:\program files\continuum\mervbot).

<ol>
<li>Edit spawns.txt (only one line of text in file needed)
 
 
bot_name : pw_for_bot_name : arena: dll_plugin : optional_staff_password 

''Example:''
<pre>2v2-Bot-League : botpw : 2v2a : 2v2league : staffpw</pre>
<ul>
<li>You should create your bot name and pw using your Continuum client as you would create any new name.
<li>There is no * in front of staffpw.
</ul>

<li>Edit MERVBot.ini
 
 
<pre>[Login]
Zone=216.33.98.254:21000 // make that your zone IP:PORT available from zone.dat in Continuum dir
</pre>

<li>Edit operators.txt
 
 
access_level : name : 

''Example:''
<pre>
4:my_name:
4:another_sysop:
3:other_person:
</pre>

<li>Run MERVBot.exe
 
 
Double click MERVBot.exe, the bot should now enter the zone. ''Note:'' Bot needs to be on vip.txt or have moderator+ access to enter a zone.
 
 
<li>Modify your MERVBot code
 
 
You can open your MERVBot project by opening "mybot.dsw" file with visual c++.
(example c:\program files\continuum\mervbot\src\mybot\mybot.dsw)

Edit the spawn.h, spawn.cpp, and command.cpp to create your plugin, then build, copy your updated DLL to your MERVBot.exe folder and then execute the bot.

Use the tutorial to get ideas on how to implement certain types of features into the bot.

</ol>

==Player Commands - (command.cpp)==

This section describes how to implement player commands into your plugin. Commands are sent to the botInfo::gotCommand function in command.cpp.

Example (makes bot reply to !test with "hi"):
<pre>
void botInfo::gotCommand(Player *p, Command *c) {
switch (p->access)
{
case OP_Player: //appropriate staff rank here. (If you want it to be a moderator command, put it under OP_Moderator.)
{
if (c->check("test")) //replace "test" with whatever command you want
{
//put your command code here
sendPrivate(p,"hi");
}
}
</pre>

===How to have commands with numerical parameters===
Example (!test #):
<pre>
if (c->check("test")) { // reads in test #, default to 1 if invalid number input
int temp = 1;

if (isNumeric(c->final))
temp = atoi(c->final);
</pre>

===How to have player name as input===
Example (!rank player):
<pre>
if (c->check("rank"))
{
String player_name = c->final;

if (player_name.IsEmpty()) // default name to self if invalid name
player_name = p->name;
</pre>

===How to have multi-parameter input===

Use the CRT function sscanf() to scan the string for the values.

Example (!squads squadA vs squadB ''or'' !squads teamA:squadA:teamB:squadB):
<pre>
else if (c->check("squads"))
{
char squadA[20], squadB[20];
int teamA, teamB;

strncpy(squadA, "", 20);
strncpy(squadB, "", 20);

int n_found;

//Note: %[A-Za-z ] is equivalent to %s, but allows an internal space.

//scan the string for the two squads separated by " vs "
n_found = sscanf(c->final, "%[A-Za-z ] vs %[A-Za-z ]", squadA, squadB);

//if that fails, scan the string for freqA:squadA:freqB:squadB
if (n_found < 2)
sscanf(c->final, "%d:%[A-Za-z ]:%d:%[A-Za-z ]", &teamA, squadA, &teamB, squadB);
}
</pre>

===Help Menu===
When a player sends !help to the bot, MERVBot calls botInfo::gotHelp() in each plugin loaded.
<pre>
void botInfo::gotHelp(Player *p, Command *c)
{
if (!*c->final)
{
sendPrivate(p, "4v4 Bot General Commands:");
sendPrivate(p, "------------------------");
sendPrivate(p, "!caps - get captain names");
sendPrivate(p, "!roster <squad> - get roster of a squad");
sendPrivate(p, "!schedule- get current schedule");
sendPrivate(p, "!score - get current score");
</pre>

==Event Calls==

MERVBot is event based, so when making a bot you need to decide what will happen at certain events. Normal plugins need to consider what happens when bot enters arena, player enters arena, player leaves arena, player events like kill, shipchange, teamchange, spec, move then any other relevant events to your bot. Just worry about events that are relevant to the tasks your bot is doing.

MERVBot sends events to botInfo::gotEvent() in spawn.cpp. Each supported event is already present and categorized in gotEvent(), along with the paramters that MERVBot sends with the event.

See dllcore.h for a list of current events and their descriptions.

==Messaging - How to use the messaging system==

Private message - void sendPrivate(Player *player, char *msg);

''Examples:''

<pre>
sendPrivate(p,"hi");

String s="test";
sendPrivate(p,s);

String s="test";
s += "ing";
sendPrivate(p,s);

char captain1[20];
char captain2[20];
strncpy(captain1,"",20);
strncpy(captain2,"",20);
sendPrivate(p,(String) captain1 + " and " + (String) captain2 + " are the captains.");
</pre>

Team message - void sendTeamPrivate(Uint16 team, char *msg); 
<blockquote>Examples: 
a) sendTeamPrivate(8025,"hi spec freq"); 
b) Uint16 test=0; sendTeamPrivate(test,"hi freq 0"); 
</blockquote>

Public message - void sendPublic(char *msg); 
<blockquote>Example: sendPublic("*arena " + (String) p->name + " is now a captain"); 
</blockquote>
Chat channel message - void sendChannel(char *msg); 
<blockquote>Example: sendChannel("hi chat channel"); 
</blockquote>
Remote private message - void sendRemotePrivate(char *name, char *msg); 
<blockquote>Example: sendRemotePrivate("Player01", "hi"); 
</blockquote>

Note: to have bot print several lines of text fast it needs sysop in the
arena (sysop in arena bot first spawns to also) otherwise it'll print slow to avoid being
kicked for spam 

==Timer - How to use the timing function==

Each time MERVBot sends an EVENT_Tick to a plugin (once a second), the default handler code decrements each value in an array of countdowns. You can modify the number of countdowns and add code to occur at a specific value for one of the countdowns.

Setup number of timers and initialize in spawn.h:
<pre>
class botInfo
{
#define COUNTDOWNS 10 // how many countdowns you want
int countdown[COUNTDOWNS]; // this gives you 10 timers

// unrelated code

public:
botInfo(CALL_HANDLE given)
{
countdown[0] = 0;
countdown[1] = 60; // 60 seconds
//
// initialize values
//
countdown[9] = 5*60; // 5 minutes
</pre>
Using timer functions in spawn.cpp:
<pre>
case EVENT_Tick:
{
for (int i = 0; i < COUNTDOWNS; ++i) //cycles through each countdown you have
--countdown[i]; //note that countdowns will continue decrementing past 0.

if (countdown[1] == 2) // when timer #1 hits two seconds
{
// do stuff here when timer #1 hits 2 seconds
// example: sendPublic("two seconds left, setting timer to 1 minute");
// example: countdown[1] = 60; // change timer #1 value
}
</pre>

You can then have events (such as EVENT_PlayerDeath) change the value of a countdown to make the bot do something a set time after an event occurs.

==Writing Functions==
<blockquote>
<blockquote>Write your function in spawn.cpp at top of file in the //////// DLL "import" //////// section
<blockquote>    //////// DLL "import" //////// 
 

    bool closeto(Player *p, int x, int y, int tolerance)  // note uses abs() function declared elsewhere 
    { 
            // return if player
p is in area of square with center x,y and radius = tolerance 

        return (abs((p->tile.x) - x) <
tolerance) && (abs((p->tile.y) - y) < tolerance); 

                } 
</blockquote> If
you want your function to have access to data from the spawn.h botInfo section 
<blockquote>public: 
    botInfo(CALL_HANDLE given) 
    { 
 
   // then you need to make your spawn.cpp function in the format: 
 
        bool botInfo::closeto(Player *p, int x, int y, int tolerance) 
        { 
          // function here 
         } 
 
Include function in spawn.h at bottom of file with the other functions 
<blockquote>    public: 

    botInfo(CALL_HANDLE given) 

    { 

    } 
 

    bool closeto(Player *p, int x, int y, int tolerance); 
     // your new function. note: w/o botInfo keyword and with a ; 
 

    void clear_objects();  // functions already there 

    void object_target(Player *p); // functions already there</blockquote>

 </blockquote>
 </blockquote>
 <blockquote>Pass values by reference
<blockquote>bool botInfo::closeto(Player *p, int& x, int y, int tolerance)  // note the & 
 
bool is_close = closeto(p,x,y,tolerance);  // if x is changed in closeto() its saved here 
</blockquote>
 </blockquote>

 <blockquote>Pass array as parameter 
<blockquote>int freqs[5]; 
 
my_function(freqs);  // call function - notice freqs and not freqs[5] or freqs[] 
 
void my_function(int freqs[]) {}  // function - notice freqs[] and not freqs[5] or freqs 
</blockquote>
 </blockquote>
<a name="6"></a>
==Cycling players- How to search through the players in the arena==
<blockquote>    _listnode <Player> *parse = playerlist->head; 
     
    while (parse) 
    { 
        Player *p = parse->item; 
 
        // do functionality here 
        // Example 1: sendPrivate(p,"*watchdamage"); // turns on all pilot's watchdamage 
        // Example 2: if (p->safety != 0)
sendPrivate(p,"*spec"); // spec all pilots in safe zone 
 
        parse = parse->next 
      } 
</blockquote>
 

==Checking if pilot is in a safe zone==
<blockquote>    if (p->safety != 0)  // pilot is in a safe zone 
    if (p->safety == 0)  // pilot is NOT in a safe zone 
 
    To detect a pilot entering a safe zone do: 
 
        case EVENT_PlayerMove: 
        { 
            if (p->safety != 0) 
</blockquote> 

==Random number==
<blockquote>Method 1 (completely random) 
<blockquote>    #include "time.h" 
 
    srand(time(NULL)); 
    rand(); 
    int temp = (int) (51 * ((float)rand()/RAND_MAX));  // returns a random integer between 0 and 51 
</blockquote>
 
Method 2 (random pilot in arena) 
<blockquote>    #include <stdlib.h> 
 
    int temp = GetTickCount() % getIngame();  // getIngame() = how many pilots in arena 
 
    _listnode <Player> *parse = playerlist->head; 
    while (parse) 
    { 
        Player *p = parse->item; 
 
        if (p->ship != SHIP_Spectator){  // if not in spec 
        if (!(--temp) {  // decrement temp, if its 0, make this pilot rabbit 
            rabbit = p; 
            break; 
            }} 
    parse = parse->next; 
    } 
</blockquote>
 </blockquote>
 
<a name="9"></a>
==Tracking time not using countdown[n]==
<blockquote>    #include <stdlib.h> 
 
    int temp = GetTickCount(); // get time stamp 
    // later in program 
    temp = (GetTickCount() - temp)/1000; // how many seconds have passed 
</blockquote>
 

==Storing data for pilots==
<blockquote>There are several ways to store data for pilots (ie tracking flagtime or kills in a period of time) 
 
1) get/setTag - use if you only want to track data until pilot leaves arena then its erased 
built in tags track by an ID that is reset when pilot leaves/enters arena, so loses track of data once they leave arena 
 
2) modified perm get/setTag - use if you want to track all pilots even if they leave (advantage - easier to sort by player) 
also can track near unlimited amount of pilots 
 
3) structs - use to track all pilots even if they leave, (advantage -
easier to sort by freqs), have to specify bound of players 
 
note: 2 and 3 are similar in effect, mostly the difference is in how you are able to search through data 
you need to decide which method of storing data is best for each bot depending on what it does 
beware using modified perm get/setTag if bot is in an arena for long periods
of time, data is not reset so the linkedlist could get huge 
 

// initialize values in spawn.h at very top 
 
1) Built in get/setTag method</blockquote><blockquote><blockquote>    #define DMG_DEALT        0 
    #define DMG_TAKEN        1 
 
    // in spawn.cpp initialize the values on arena-enter and player-enter 
     
        case EVENT_ArenaEnter: { 
 
            _listnode <Player> *parse = playerlist->head; 
 
            while (parse) // do for all pilots in arena when bot enters 
            { 
                Player *p = parse->item;  // get pilot 
 
                set_tag(p, DMG_DEALT, 0); // initialize to 0 
                set_tag(p, DMG_TAKEN, 0); 
             
                sendPrivate(p,"*watchdamage"); 
// optionally turn on player *watchdamage 
 
                parse = parse->next;  // get next pilot 
                } 
            } 
 
        case EVENT_PlayerEntering: { 
 
            set_tag(p, DMG_DEALT, 0); // initialize to 0 
            set_tag(p, DMG_TAKEN, 0); 
 
            sendPrivate(p,"*watchdamage"); 
 
    // then somewhere edit the tag values 
 
        case EVENT_WatchDamage:  { 
 
            // sets tag for k (shooter) to be old value plus damage dealt currently 
            set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT) + damage); 
 
 // how to retrieve the tag values 
 
        // as a command in spawn.h 
 
        else if (c->check("showstats")) { 
 
            int temp = get_tag(p, DMG_TOTAL_DEALT); 
 
            String s = "You've done "; 
            s += temp; 
            s += " damage so far!"; 
 
            sendPrivate(p,s); 
 
    // kill tags when player leaves arena 
 
        case EVENT_PlayerLeaving: { 
 
            killTags(p); 
</blockquote>2) Modified permanent get/setTag method 
<blockquote>// same as get/setTag with some modifications to the tag code, then can use tags exactly as above 
 
// spawn.h, add char name[20]; into struct PlayerTag 
<blockquote>struct PlayerTag 
{ 
    Player *p; 
    char name[20]; 
    int index; 
    int data; 
}; 
</blockquote>
// spawn.cpp, modifications 
<blockquote>case EVENT_PlayerLeaving: 
{ 
    Player *p = (Player*)event.p[0]; 
 
    // killTags(p);  // remove so tag not deleted on arena exit 
 
</blockquote>
 <blockquote>int botInfo::get_tag(Player *p, int index) 
{ 
    _listnode <PlayerTag> *parse = taglist.head; 
    PlayerTag *tag; 
 
    while (parse) 
    { 
tag = parse->item; 
 
// if (tag->p == p) 
if (strcmp(tag->name,p->name)==0)  // now tracking by player name, not ID 
if (tag->index == index) 
    return tag->data; 
 
parse = parse->next; 
    } 
 
    return 0; 
} 
 
void botInfo::set_tag(Player *p, int index, int data) 
{ 
    _listnode <PlayerTag> *parse = taglist.head; 
    PlayerTag *tag; 
 
    while (parse) 
    { 
tag = parse->item; 
 
//if (tag->p == p) 
       if (strcmp(tag->name,p->name)==0) // now tracking by player name, not ID 
if (tag->index == index) 
{ 
    tag->data = data; 
    return; 
} 
parse = parse->next; 
    } 
 
    tag = new PlayerTag; 
    // tag->p = p; // not tracking by ID anymore 
    strncpy(tag->name, p->name, 20); // tracking by player name 
    tag->index = index; 
    tag->data = data; 
    taglist.append(tag); 
}</blockquote>
 </blockquote>
3) Using Struct's 
<blockquote>struct name                     
    {              
          
 

    // variables                   

    }; 
 
// Example: (in spawn.h) 
<blockquote>class botInfo 
{ 
 
struct freqdata { 
int kills; 
 int deaths; 
}; 
 
freqdata freqs[100]; // 100 of those structs 
 
// then access it in spawn.cpp using 
freqs[56].kills = 1; 
</blockquote>
 </blockquote>
 
</blockquote>

==Output of data/messages==
 
    using normal Strings 
 
        // does *arena X pilots left in the game. 
 
         String s = "*arena "; 
         s += temp;  // some variable (int) 
         s += " pilots left in the game."; 
         sendPublic(s) 

<blockquote>OR 

</blockquote>
 <blockquote>sendPublic("*arena " + (String) temp + " pilots left in the game."); 

</blockquote>

 
    example using sprintf to align/space data 
 
            // output data
will be in this approximate format (not lined up perfectly because of html) 
 
            //
---------------------------------------------------------------------------------------- 
            // Squad: squadname      
PTS     FPTS    K    D  DMG DEALT
TAKEN   F  FK    FLT       
     // ---------------------------------------------------------------------------------------- 
            //
PlayerA          
         10000        500
116 101               
9999    99999 10 150 980:55           
 // PlayerB              
         500       
200     7     5     
          9999    99999  5  
   3     0:04 
 
            char str[255]; 
            sendPublic("*arena----------------------------------------------------------------------------------"); 
            sprintf(str, "*arena
Squad: %-20s   PTS     FPTS   K  
D  DMG DEALT  TAKEN  F  FK    FLT",freqs[freq].freqname); 
            sendPublic(str); 
            sendPublic("*arena----------------------------------------------------------------------------------"); 
 
            // assuming existing freqs struct with data 
            for (pilot=freqs[freq].playercount-1; pilot>=0; pilot--) 
            { 
                // on freq squad so print stats 
                char outString[255]; 
 
                sprintf(outString,
"*arena %-20s %12d %8d %3d %3d %10d %6d %2d %3d %3d:%02d",freqs[freq].pilots[pilot].name, 
                freqs[freq].pilots[pilot].points,
freqs[freq].pilots[pilot].flagpoints, freqs[freq].pilots[pilot].kills, 
                freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].dmgdealt, freqs[freq].pilots[pilot].dmgtaken,freqs[freq].pilots[pilot].flags, 
       
 freqs[freq].pilots[pilot].flagkills, freqs[freq].pilots[pilot].flagtime
/60, freqs[freq].pilots[pilot].flagtime %60); 
                 
                sendPublic(outString); 
            } 
 
            // Notes: sprintf
format = sprintf(output char string, spacing, variables) 
            // Notes: s = chars, d = integer, - = left align, right align default 
            // Notes: doing
%02d = put 0 in front if not 2 digits, %3d:%02d makes 0:04 format 
 
 
<a name="12"></a>
==Input/Output to files==

<blockquote>Input to file 
<blockquote>// example reading from duel.ini looking for line that starts with MaxBoxes= then taking the next char as value to store as 
// MAX_BOXES (ie duel.ini = MaxBoxes=5) 
#include <fstream> 
using namespace std; 
 
ifstream file("duel.ini"); 
    char line[256]; 
 
    // read in MaxBoxes=X 
    while (file.getline(line, 256)) 
    { 
if (CMPSTART("MaxBoxes=", line)) 
{ 
    MAX_BOXES = atoi(&(line[9])); 
    break; 
} 
    } 
</blockquote>
Output to file 

<blockquote>// normal char output 

<blockquote>#include <fstream> 

using namespace std; 

 

ofstream file("duelleaguestat.inc", ios::app);   // app = put all data at end of file 

 

file << squad1<< endl;  // squad1 = char[20] 

file << " vs "<< endl; 

file << squad2<< endl;  // squad2 = char[20] 

</blockquote>

// how to output String's
to file (key is converting String to (char*) to file write) 

<blockquote>
String str = freqs[freq].slotname[slot]; 

str += ", Repels: " + (String)(int) t->repel; 

       
       
    

outf << endl; 

outf << (char*) str; 

</blockquote>

 
// date and time stamp 

<blockquote>#include "time.h" 
 
char u[100]; 
time_t t=time(NULL); 
tm *tmp = localtime(&t); 
strftime(u,99,"%c",tmp); 
sendPublic("Date and time: " + (String) u); 

</blockquote>
 </blockquote>
</blockquote>
 <blockquote>Example reading input from file using "GetPrivateProfileString" (from rampage plugin) 
<blockquote>format of rampage.ini 
<blockquote>7=is on a killing spree! (6:0) 10=is opening a can of whoop-ass! (9:0) 
</blockquote>
read input 
<blockquote>rampageini.h 
<blockquote>#pragma once 

#ifndef RAMPAGEINI_H 
#define RAMPAGEINI_H 
 
#define NUM_RANKS 10 
#define BUFFER_LEN 256 
 
struct RampageSettings 
{ 
    char quotes[NUM_RANKS][BUFFER_LEN]; 
}; 
 
void LoadSettings(RampageSettings &setts); 
 
#endif    // RAMPAGEINI_H 
</blockquote>
rampageini.cpp 
<blockquote>#include "rampageini.h" 
static char buffer[BUFFER_LEN]; 
static char path[BUFFER_LEN]; 
#include "../algorithms.h" 
#define WIN32_LEAN_AND_MEAN 
#include <windows.h> 

 
char *rank_type[10] = { 
    "7", 
    "10", 
}; 
 
void LoadSettings(RampageSettings &setts) 
{ 
    GetCurrentDirectory(BUFFER_LEN - 64, path); 
    strcat(path, "\rampage.ini"); 

 
    for (int i = 0; i < NUM_RANKS; ++i) 
    { 
        GetPrivateProfileString("Comments",
rank_type[i], "-ERROR-", setts.quotes[i], BUFFER_LEN, path); 
    } 
} 
</blockquote>
 </blockquote> </blockquote> </blockquote>

==Simple programming commands==

<blockquote>simple commands     

<blockquote>
    declare/initialize variables   // example:  int
temp;  int temp2 = 1;  temp2 = 3;   
                     
                     
// bool check = true; check = false; 

 
    if (condition) {}          
     // example: if (a > b) { a++; } 

 

    if (condition) {} else {}       
     // example: if (b <= 0) { b--; } else { a++;
} 

 

    while (condition) {}          
     // example: while (b > 0) { b--; } 

 

    for (initialize; condition; increment){}  
 // example: for (a=1; a < 10; a++) { a = a + b; } 

</blockquote>

array 

<blockquote>single dimension 

<blockquote>int teams[100];   // create 100 hundred teams 0-99 

 
teams[50] = 1; 

</blockquote>
multi-dimensional 

<blockquote>int teams[100][50];  // multidimensional arry 

 
teams[99][49] = 2; 

</blockquote>
variable size 

<blockquote>String *list = new String[amount+1]; // string array with size amount (variable) + 1; 

 
list[amount-1] = "hi"; 

</blockquote> </blockquote>
struct     

<blockquote>    struct name          
  

    {              
          
  

    // variables          
       

    }; 

<blockquote>// example: 
struct freqdata {
int kills; int deaths; }; 

 
freqdata freqs[100]; // 100 of those structs 

 
freqs[56].kills =
1;  // access struct 

</blockquote> </blockquote>

switch     

<blockquote>switch (variable)          
   

    {              
          
   

        case n:      
        

        { }          
       
    

        break;      
                  

                  
                 
      

        case m:      
      

        {  }       
                 
  

        break;      
      

         

        default: 

        break; 

    } 

<blockquote> <blockquote>// Example: 
switch (p->ship) { 

 
    case SHIP_Warbird:  { 
sendPrivate(p,"You're in a warbird"); 
}  break; 

 
        default: 
            break;</blockquote> </blockquote>

 </blockquote>
 </blockquote>

 
==Useful Player data==
<blockquote>

// useful data stored
by MervBot about each player (player.h) 

 

p->name = player name stored as char[20] 
p->squad = player squad stored as char[20] 
p->ship = ship (0-7) enumerated as SHIP_Warbird, SHIP_Spectator, etc.. 
p->safety = if ship is in safety zone (boolean) 
p->bounty = player bounty 
p->energy = player energy (have bot with *energy on to get accurate readings) 
p->flagCount = how many flags player is holding 

p->team = player frequency 
p->(burst, repel, thor, brick, decoy, rocket, portal) = how many items of that type player has 
p->(stealth, cloak, xradar, awarp, ufo, flash, safety, shields, supers) = if player has that item on (boolean) 

p->score.killPoints = player kill points 
p->score.flagPoints = player flag points 
p->score.wins = player kills from f2 
p->score.losses = player deaths from f2 
</blockquote>
 
 
==Bot built in functions==
<blockquote>// useful MervBot commands to control what the bot is doing 
 
// player.cpp 
Player::move(Sint32 x, Sint32 y)  // example  me->move(512,512) - bot moves to coord 512 512 
Player::clone(Player *p) // example  me->clone(p) 
 
// dllcore.cpp (descriptions of functions in dllcore.h) 
 
BotEvent makeEcho                (char *m); 
BotEvent makeSay                (int t, int s, int i, char *m); 
 
BotEvent makeShip                (int s); 
BotEvent makeTeam                (int t); 
BotEvent makeGrabFlag            (int f); 
BotEvent makeSendPosition        (bool reliable); 
BotEvent makeDropFlags            (); 
 
BotEvent makeDeath                (Player *p); 
BotEvent makeAttach                (Player *p); 
BotEvent makeDetach                (); 
BotEvent makeFollowing            (bool f); 
BotEvent makeFlying                (bool f); 
BotEvent makeBanner                (BYTE *b); 
BotEvent makeDropBrick            (); 
BotEvent makeFireWeapon            (void *weapon_info); 
 
BotEvent makeToggleObjects        (Uint16 player, Uint16 *objects, int num_objects); 
 
BotEvent makeSpawnBot           
(char *name, char *password, char *staff, char *arena); 
BotEvent makeChangeArena        (char *name); 
BotEvent makeChangeSettings        (_linkedlist <String> *settings); 
 
// example how to use them: 
 
tell(makeFollowing(false)); 
 
// look in Commands.txt , command.cpp (core), or /!help to bot to see all bot external commands (example /!go <arena>) 
</blockquote>

==Example Code==

<a name="15a"></a>
a) No antiwarp in center of map (take green away and warn) 

<blockquote>// using function closeto() and abs() </blockquote> <blockquote>
bool closeto(Player *p, int x, int y, int tolerance) { 
    return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); } 
inline int abs(int n) { 
    if (n < 0)    return -n; 
    else        return n; } 
radius = 35;  // global variable </blockquote> <blockquote>case EVENT_PlayerMove: { 
    Player *p = (Player*)event.p[0]; 
    // no anti in center 
    if ((p->ship != SHIP_Spectator) && (p->awarp)) { 
        if (closeto(p, 512, 512, radius)){ 
            sendPrivate(p, "*prize #-20"); 
       
    sendPrivate(p, "*warn Antiwarp is not allowed in center."); 
        } 
    } </blockquote>

<a name="15b"></a>

b) Setting freq size depending on how many pilots in game 

<blockquote>
case EVENT_Tick:  { 
<blockquote>if (countdown[0] == 0) {     // assuming countdown[0] initialized to > 0  in spawn.h, freqchange=0; 
</blockquote>
               
_listnode <Player> *parse = playerlist->head; 
        int count = 0; 
        while (parse) 
        { 
            Player *p = parse->item; 
            if (p->ship != SHIP_Spectator) 
            ++count; 
            parse = parse->next; 
        } 
        if ((count > 24) && (freqchange != 4)) 
        { 
       
    sendPublic("?set team:maxperteam:4"); 
            String s; 
            s = "Max freq size 4  ("; 
            s += count; 
            s += " pilots in game)"; 
            sendPublic(s); 
            freqchange = 4; 
        } 
       
if ((count < 25) && (count > 14) && (freqchange !=
3)) 
        { 
       
    sendPublic("?set team:maxperteam:3"); 
            String s; 
            s = "Max freq size 3  ("; 
            s += count; 
            s += " pilots in game)"; 
            sendPublic(s); 
            freqchange = 3; 
        } <blockquote>countdown[0] = 120; 
} </blockquote></blockquote>

<a name="15c"></a> c) Tracking kills and announcing when pilot gets 10 kills in a row without
dying

<blockquote>case EVENT_PlayerDeath:  { 
<blockquote>// assuming tags are setup (see storing data section) 
set_tag(p,KILLS, 0);  // pilot died, reset to 0 kills in a row 
set_tag(k, KILLS, get_tag(k, KILLS) + 1);  // pilot killed someone, increment kills in a row by 1 
if (get_tag(k,KILLS) == 10)  sendPublic("*arena (String) k->name + " has gotten 10 kills.");</blockquote></blockquote>

<a name="15d"></a>

d) Warp pilot to coord when they are in a certain region 

<blockquote>// using functions closeto() and abs() 
bool closeto(Player *p, int x, int y, int tolerance) { 

    return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); } 

inline int abs(int n) { 

    if (n < 0)    return -n; 

    else        return n; } 
case EVENT_PlayerMove:    { 
if (closeto(p, 509, 509, 2)) {  // if pilot within 2 of map coord 509,509 
    sendPrivate(p, "*warpto 509 504");  // warp to coord 509,504 </blockquote>

 

<a name="15e"></a>

e) Structures within structures (spawn.h botinfo) 

<blockquote>    // Declare in spawn.h <blockquote>    struct playerstats 
    { 
char name[20]; 
int kills; 
int deaths; 
Uint16 points; 
Uint16 flagpoints; 
int flagtime; 
int cflagtime; 
int flags; 
int flagkills; 
int dmgdealt; 
int dmgtaken; 
    }; 
    struct freqdata 
    { 
playerstats pilots[100]; 
int freqpoints; 
char freqname[20]; 
int freqflagpoints; 
Uint16 freqteam; 
int freqflagtime; 
int flags; 
int kills; 
int deaths; 
int flagkills; 
int dmgdealt; 
int dmgtaken; 
int playercount; 
    }; 
    freqdata freqs[100]; </blockquote>
// Initialize in spawn.cpp <blockquote>void botInfo::Clear() 
{ 
    // initialize/clear struct data 
    for (int n=99; n>=0; n--) 
    { 
freqs[n].freqteam=-1; 
freqs[n].freqpoints=0; 
freqs[n].freqflagpoints=0; 
freqs[n].playercount=0; 
freqs[n].flags=0; 
freqs[n].kills=0; 
freqs[n].deaths=0; 
freqs[n].freqflagtime=0; 
freqs[n].flagkills=0; 
freqs[n].dmgdealt=0; 
freqs[n].dmgtaken=0; 
 
for (int m = 99; m>=0; m--) 
{ 
    freqs[n].pilots[m].deaths=0; 
    freqs[n].pilots[m].kills=0; 
    freqs[n].pilots[m].points=0; 
    freqs[n].pilots[m].flagpoints=0; 
    freqs[n].pilots[m].flagtime=0; 
    freqs[n].pilots[m].cflagtime=0; 
    freqs[n].pilots[m].flags=0; 
    freqs[n].pilots[m].flagkills=0; 
    freqs[n].pilots[m].dmgdealt=0; 
    freqs[n].pilots[m].dmgtaken=0; 
} 
    } 
} </blockquote></blockquote> <blockquote>// Access data in spawn.cpp 
<blockquote>int freq = p->team; 
freqs[1].pilots[2].kills++; 
OR 
freqs[freq].deaths++; </blockquote></blockquote>

<a name="15f"></a>

f) Tracking flag data 

<blockquote>Example GetPilot() function  (using structs from example e) <blockquote>bool botInfo::GetPilot(Player *p) 
{ 
    // get a pilots freq/pilot id from struct 
    for (freq=freqcount-1; freq>=0; freq--) 
if (p->team == freqs[freq].freqteam) 
    for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--) 
       
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0) 
            return true; 
    return false; 
} 
</blockquote></blockquote>
 
<blockquote>Example way to track flag data using above struct/functions <blockquote>
case EVENT_FlagGrab: 
{ 
    if (GetPilot(p))  // function 
    { 
        freqs[freq].pilots[pilot].flags++; 
        freqs[freq].flags++; 
       
if (freqs[freq].pilots[pilot].flags < 2) // didnt have a flag before,
first flag 
       
    freqs[freq].pilots[pilot].cflagtime = GetTickCount();
 // time stamp when picked up flag 
    } </blockquote></blockquote>
 <blockquote>Example way to track flag data using built in get/set tag (from catid flagbot) 

<blockquote>
case EVENT_FlagGrab: 

{ 

    set_tag(p, TAG_STAT_FS, get_tag(p, TAG_STAT_FS) + 1); 

    set_tag(p, TAG_FLAGTIMER, GetTickCount()); 

} 

</blockquote> </blockquote> <blockquote>Get current flag times using struct format 

<blockquote>void botInfo::SetFlagTimes() 
{ 
    // set current flagtime for pilots/freqs 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
Player *p = parse->item; 

 
if (GetPilot(p)) 
    if (freqs[freq].pilots[pilot].flags > 0) 
    { 
        if (PilotOnSquad(p)) 
       
    freqs[freq].freqflagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000; 

 
       
freqs[freq].pilots[pilot].flagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000; 
       
freqs[freq].pilots[pilot].cflagtime = GetTickCount(); 
    } 

 
parse = parse->next; 
    } 
} 

</blockquote>
// side note:  case EVENT_FlagDrop: {} gets called anytime theres a teamkill 

</blockquote>

 

<a name="15g"></a>
g) Example way to do simple /!spam feature (allowed 1x/60s) 

<blockquote>declare and initialize variables in spawn.h 

<blockquote>class botInfo 
{ 
bool spamready; 
int SPAM_TIME; 

 
public: 
    botInfo(CALL_HANDLE given) 
    { 
    spamready = true; 
    SPAM_TIME = 60; 

</blockquote>
spawn.cpp - mark as spamready=true when 60 seconds up 

<blockquote>case EVENT_Tick: 
{ 
    if (countdown[0] == 1)  { 
        spamready = true;  // ready to spam again 
    } 

</blockquote>

 
command.cpp - handle !spam command 

<blockquote>case OP_Player: 
{    // Player-level commands 

 
else if (c->check("spam")) 
    { 
       
// zone announcement "Need pilots to duel in ?go arena -pilotname" 
        if (spamready == true) 
            { 
            String s; 
       
    s += "*zone Need pilots to duel in ?go "; 
            s += arena; 
            s += " - "; 
            s += p->name; 
            sendPublic(s); 
          
            spamready=false; 
       
    countdown[0] = SPAM_TIME * 60; // next spam time limit 
            } 
        else if (countdown[0] < 0) 
        { 
       
    sendPrivate(p,"Spam ability disabled."); 
        } 
        else 
            { 
            String s; 
            s += SPAM_TIME; 
       
    s += " Minute timer between announcements. "; 
            s += countdown[0] / 60; 
            s += ":"; 
            if (countdown[0] % 60 < 10) 
                s += "0"; 
            s += countdown[0] % 60; 
       
    s += " minutes left before next spam allowed."; 
            sendPrivate(p, s); 
            } 
    } 

</blockquote> </blockquote>

<a name="15h"></a>
h) Example of implementing a simple stack to do "next in line for several 'boxes' at once" 

<blockquote>//spawn.h declare variables 

<blockquote>class botInfo 
{ 
Player *next[99][99]; 
int MAX_NEXT; 
int nextcount[99]; 

 
public: 
    botInfo(CALL_HANDLE given) 
    { 
    MAX_NEXT = 8; 

</blockquote>
// spawn.cpp MoveUp function 

<blockquote>void botInfo::MoveUp(int pos, int box) 
{ 
    // moves up the next line for that box and decrement box's nextcount 
    if (nextcount[box] > 0) 
nextcount[box]--; 

 
    for (pos = pos; pos < MAX_NEXT - 1; pos++) 
    { 
next[box][pos] = next[box][pos + 1]; 
    } 

 
    next[box][MAX_NEXT] = 0; 
} 

</blockquote>
 </blockquote>

<a name="15i"></a>
i) Example of reading any text from a .txt and printing it to pilot line by line 

<blockquote>#include <fstream> 
using namespace std; 

 
case OP_Player: 
{ 
    if (c->check("schedule")) 
    { 
        // read in schedule from schedule.txt 
        ifstream file("schedule.txt"); 
        char line[256]; 

 
        while (file.getline(line, 256)) 
        { 
            sendPrivate(p, line); 
        } 
        file.close(); 
    } 

</blockquote>

<a name="15j"></a>
j) Example of printing player stats grid 

<blockquote>// spawn.cpp   (see "structures within structures" example for variable declarations, varibale freqcount = # of freqs) 

 
void botInfo::DisplayPlayers() 
{ 
    // Display Match player/freq stats in this format  (not aligned b/c of html but aligned in bot) 
    // --------------------------------------------------- 
    // Squad: squad_name_1            
K  D TK DMG DEALT TAKEN 
    // --------------------------------------------------- 
    // Player_1                      
0  0  0         0    
0     // Player_2                      
0  0  0         0    
0     // TOTAL:                     
0  0  0         0    
0 
    // --------------------------------------------------- 
    // Squad: squad_name_2            
K  D TK DMG DEALT TAKEN 

    // --------------------------------------------------- 
    // Player_3                      
0  0  0         0    
0     // Player_4                      
0  0  0         0    
0     // Player_5                      
0  0  0         0    
0     // TOTAL:                     
0  0  0         0    
0 
    // --------------------------------------------------- 

 
    for (freq=freqcount-1; freq>=0; freq--) 
    { 
char str[255]; 

 
sendFreqs("---------------------------------------------------"); 

 
sprintf(str, "Squad: %-20s K  D TK DMG DEALT TAKEN", freqs[freq].freqname); 
sendFreqs(str); 

 
sendFreqs("---------------------------------------------------"); 

 
for (pilot=freqs[freq].playercount-1; pilot >= 0; pilot--) 
{ 
    sprintf(str, "%-20s
%8d %2d %2d %9d %5d", freqs[freq].pilots[pilot].name, freqs[freq].pilots[pilot].kills, 
       
    freqs[freq].pilots[pilot].deaths, freqs[freq].pilots[pilot].teamkills,
freqs[freq].pilots[pilot].dmgdealt, 
       
    freqs[freq].pilots[pilot].dmgtaken); 
    sendFreqs(str); 
} 

        
sprintf(str, "TOTAL:                    
%2d %2d %2d %9d %5d", freqs[freq].kills, freqs[freq].deaths, 
    freqs[freq].teamkills, freqs[freq].dmgdealt, freqs[freq].dmgtaken); 
sendFreqs(str); 
    } 

 
    sendFreqs("---------------------------------------------------"); 
} 

</blockquote>

<a name="15k"></a> k) Example of checking if any pilots are
within a region

<blockquote>// see GetPilotName(name) function in other example, returns *player as TempPlayer from name 
// closeto() function from several previous examples 

 
bool botInfo::FreqAInBox() 
{ 
    // return true if teamA has a pilot in the box, otherwise false 
    for (int tempplayercount = freqs[0].playercount-1; tempplayercount >= 0; tempplayercount--) 
if (GetPilotName(freqs[0].pilots[tempplayercount].name)) 
    if (closeto(TempPlayer,
coordX, coordY, 73) && (TempPlayer->ship != SHIP_Spectator)) 
        return true; 

 
    return false; 
} 

</blockquote>

<a name="15l"></a>
l) Example of functions to get a pilot's struct id info from a name or *player info 

<blockquote>// see struct examples for variable info 

 
// return struct freq/pilot id from *player info 
bool botInfo::GetPilot(Player *p) 

{ 

    // return freq, pilot of a player p 

    for (freq=freqcount-1; freq>=0; freq--) 

if (p->team == freqs[freq].freqteam) 

    for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--) 
               
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0) 

            return true; 

 

    return false; 

} 

 
// return *player as TempPlayer info from p->name info bool botInfo::GetPilotName(char *name) 
{ 
    // get pilot from a name, return as TempPlayer 
    _listnode <Player> *parse = playerlist->head; 

 
    while (parse) 
    { 
Player *p = parse->item; 

 
// convert both to lowercase to compare 
char pname[20];       
    
strncpy(pname,p->name,20); 

 
char nname[20];       
    
strncpy(nname,name,20); 

 
tolower(pname); 
tolower(nname); 

 
if (strcmp(pname,nname)==0) 
{ 
    TempPlayer = p; 
    return true; 
} 

 
parse = parse->next; 
    } 
    return false; 
} 
 
// note: better to implement these functions as passing values by reference instead of using global variables 
// just easier to not have to be declaring different int freq, int pilot all the time 

</blockquote>

<a name="15m"></a>
m) Example of creating a logfile name using date and squad names 

<blockquote>    // create log file name (squadA and squadB external char[20] variables) 
    char u[100]; 
    time_t t=time(NULL); 
    tm *tmp = localtime(&t); 
    strftime(u,99,"%y",tmp); 
    logname = "c:\Program Files\Continuum\logs\"; 
    logname += u; 
    logname += "y"; 
    strftime(u,99,"%m",tmp); 
    logname += u; 
    logname += "m"; 
    strftime(u,99,"%d",tmp); 
    logname += u; 
    logname += "d"; 
    logname += squadA; 
    logname += " vs "; 
    logname += squadB; 
    strftime(u,99,"%I",tmp); 
    logname += u; 
    logname += "h"; 
    strftime(u,99,"%M",tmp); 
    logname += u; 
    logname += "m"; 
    logname += ".txt"; 

 
// example name created:  03y01m27dBLACKDRaGON vs Integral05h08m.txt 
// format  year, month, day, squadA vs squadB, hour, minute 

</blockquote>

<a name="15n"></a>
n) Example of sending messages to playing freqs or public and logging depending on status 

<blockquote>// teamA, teamB, logname global variables 
void botInfo::sendFreqs(char *msg) 
{ 
    char *mmsg = "*arena"; 
    String s = msg; 
    
    if (teammsgs == false) 
    { 
s.prepend("*arena ",7); 
sendPublic(s); 
    } 
    else 
    { 
sendTeamPrivate(8025,msg); 
sendTeamPrivate(teamA,msg); 
sendTeamPrivate(teamB,msg); 
    } 
    if (gameon == true) 
    { 
ofstream outf(logname, ios::app); 
outf << msg << endl; 
outf.close(); 
    } 
} 

</blockquote>

<a name="15o"></a>
o) Example of reading in all player/freqs to struct data 

<blockquote>// see structures within structures example for freqs[] declaration 

 
// to get freqs in a game where there are several freqs 
void botInfo::GetFreqs() 
{ 
    // read pilots into freq struct data from ingame and on playing freqs 

 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
Player *p = parse->item; 

 
if (p->ship != SHIP_Spectator) 
    if (closeto(p, coordX, coordY, 73)) 
    { 
        // look for freq in struct 
        bool foundfreq=false; 

 
        freq=freqcount-1; 

 
        while ((freq>=0) && (foundfreq==false)) 
        { 
       
    if (p->team == freqs[freq].freqteam) 
            { 
       
foundfreq=true; 
       
strncpy(freqs[freq].pilots[freqs[freq].playercount].name,
p->name, 20); 
       
freqs[freq].playercount++;   
 
            } 
            freq--; 
        } 

 
        // didnt find freq in struct so add new freq 
        if (foundfreq == false) 
        { 
            if (manualsquads == false) 
            { 
       
strncpy(freqs[freqcount].freqname,
p->squad, 20); 

 
       
if (freqcount == 0) 
                { 
       
    teamA = p->team; 
       
    strncpy(squadA,
p->squad, 20); 
                } 
                else 
                { 
       
    teamB = p->team; 
       
    strncpy(squadB,
p->squad, 20); 
                } 
            } 
            else 
            { 
       
if (p->team == teamA) 
       
    strncpy(freqs[freqcount].freqname,squadA,20); 

 
       
else if (p->team == teamB) 
       
    strncpy(freqs[freqcount].freqname,squadB,20); 
            } 
            
       
    freqs[freqcount].freqteam = p->team; 

 
       
    strncpy(freqs[freqcount].pilots[0].name, p->name, 20); 
               
       

 
            freqs[freqcount].playercount++; 
            freqcount++; 
        } 
    } 
parse = parse->next; 
    } 
} 

 
// to get freqs in a game where there are only two teams 
void botInfo::GetFreqs() 
{ 
    // read pilots into freq struct data from ingame and on playing freqs 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
Player *p = parse->item; 

 
if ((p->ship != SHIP_Spectator)
&& ((p->team == teamA) || (p->team == teamB))) 
{ 
    // freq 100, team A 
    // set freq 
    freq = 0; 

 
    if (p->team == teamB) 
        freq = 1; 

 
    // number of pilots on freq counted so far, starts 0 
    pilot = freqs[freq].playercount; 

 
    // pilot name 
    strncpy(freqs[freq].pilots[pilot].name, p->name, 20); 
    // time stamp for playing time 
    freqs[freq].pilots[pilot].cplaying_time = GetTickCount(); 

 
    // slot name 
    if (freqs[freq].playercount < NUMBER_PILOTS) 
       
strncpy(freqs[freq].slotname[pilot], p->name, 20); 
 
    // increment freq player count 
    freqs[freq].playercount++; 

 
    // if freq not already have name, give it player squad name 
    if ((manualsquads == false) && (strlen(p->squad) > 0)) 
        strncpy(freqs[freq].freqname, p->squad, 20); 

 
            // set player ship 
    freqs[freq].pilots[pilot].ship = p->ship + 1; 
} 
parse = parse->next; 
    } 
} 

</blockquote>

<a name="15p"></a>
p) Example of finding MVP from struct data (2*kills - deaths formula) 

<blockquote>    int highest=-20; 
    int mvp=0; 

 
    for (pilot = freqs[mvpteam].playercount-1; pilot >=0; pilot--) 
    { 
if (((freqs[mvpteam].pilots[pilot].kills
* 2) - freqs[mvpteam].pilots[pilot].deaths) > highest) 
{ 
    mvp = pilot; 
    highest = (freqs[mvpteam].pilots[pilot].kills
* 2) - freqs[mvpteam].pilots[pilot].deaths; 
} 
    } 

</blockquote>

<a name="15q"></a>
q) Print time stamp of event 

<blockquote>#include "time.h" 

 
char u[100]; 
time_t t=time(NULL); 
tm *tmp = localtime(&t); 
strftime(u,99,"%c",tmp); 
sendPublic("Current date and time: " + (String) u); 

</blockquote>

<a name="15r"></a>
r) Simple way to track player bomb/bullet damage stats 

<blockquote>// spawn.cpp (see data section for how to setup set_tag) 
// see clientprot.h for weapon information 
 
case EVENT_WatchDamage: 
{ 
    if (PLAYING)  // if tracking stats 
    { 
       
if ((wi.type == PROJ_PBomb) && (p->name != k->name)) 
        { 
       
    set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT)
+ damage); 
       
    set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT)
+ damage); 
       
    set_tag(p, DMG_BOMB_TAKEN, get_tag(p, DMG_BOMB_TAKEN)
+ damage); 
       
    set_tag(p, DMG_TOTAL_TAKEN, get_tag(p, DMG_TOTAL_TAKEN)
+ damage); 
        } 
        else if (wi.type == PROJ_BBullet) 
        { 
       
    set_tag(k, DMG_BULLET_DEALT, get_tag(k, DMG_BULLET_DEALT)
+ damage); 
       
    set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT)
+ damage); 
       
    set_tag(p, DMG_BULLET_TAKEN, get_tag(k, DMG_BULLET_TAKEN)
+ damage); 
       
    set_tag(p, DMG_TOTAL_TAKEN, get_tag(k, DMG_TOTAL_TAKEN)
+ damage); 
        } 
    } 

</blockquote>

<a name="15s"></a>
s) Simple way to print those stats 

<blockquote>
<pre>
case OP_Moderator:
{
if (c->check("showstats"))
{
    sendPublic("Showing stats:");

    _listnode <Player> *parse = playerlist->head;

    while (parse)
    {
        Player *p = parse->item;

        if (get_tag(p, DMG_TOTAL_DEALT) > 0)
        {
char str[256];
    sprintf(str, "(%-20s Dmg Dealt: Total %0004d, Bomb %0004d, Bullet %0004d  Dmg TAKEN: Total %0004d, Bomb %0004d, Bullet %0004d)",
p->name, get_tag(p,DMG_TOTAL_DEALT), get_tag(p,DMG_BOMB_DEALT), get_tag(p,DMG_BULLET_DEALT),
get_tag(p,DMG_TOTAL_TAKEN), get_tag(p,DMG_BOMB_TAKEN), get_tag(p,DMG_BULLET_TAKEN));
sendPublic(str);
        }
        parse = parse->next;
    }
}
</pre>
</blockquote><a name="15t"></a>
t) Make bot spectate specific coordinates 

<blockquote>
<pre style="font-size: 11px">
// make bot spectate the coord 512,600
// possible use - capturing weapon packets in a specific region

tell(makeFollowing(false));
tell(makeFlying(true));
me->move(512 * 16, 600 * 16);
tell(makeSendPosition(true));
</pre>
</blockquote>
</blockquote></blockquote>

Talk:MERVBot Tutorial

2005-02-12T16:45:39Z

D1st0rt:

Talk:MERVBot Tutorial

2005-01-30T23:33:23Z

D1st0rt:

D1s: Anybody wanna format this int a table of contents? I'm lazy

MERVBot Tutorial

2005-01-30T23:31:35Z

D1st0rt: Underlord's MERV Tutorial

Here is the ever-popular MERVBot Tutorial by Underlord:

 <div align="center"><big><big>MERVBot Tutorial</big></big> 
 
(Written by Underlord)
<hr width="500" size="1" /></div>

 <blockquote>Setup a MERVBot bot and project in visual c++ 
0) <a href="#0">Setting up a MERVBot bot</a> 
 
Command.cpp 
 1)<a href="#1"> Player commands</a>
(!play, !squadA vs squadB) 
 
Spawn.cpp 
 2) <a href="#2">Event descriptions</a>
(describe events in spawn.cpp) 
 2) <a href="#2">Messaging </a>
("*arena hi", ":player:*scorereset) 
 3) <a href="#3">MervBot Timer</a>
(do this in 10 seconds)(countdown[n]) 
 4) <a href="#4">Writing Functions</a>
(bool IsInCenter(Player *p)) 
 
Useful operations 
 6) <a href="#6">Cycling players</a>
 
 7) <a href="#7">Check if pilot is in safe zone</a>
 
 8) <a href="#8">Random numbers</a>
 
 9) <a href="#9">Time without using countdown[n]</a>
 
10) <a href="#10">Storing data for pilots</a>
 
11) <a href="#11">Output data in messages</a>
 
12) <a href="#12">Input/Output to files</a>
 
13) <a href="#13">Programming commands</a>
 
14) <a href="#14">Useful player data</a> 
15) <a href="#15">Bot built in functions</a>
 
Example Code 
<blockquote>a) <a href="#15a">No antiwarp in center of map</a>
 
b) <a href="#15b">Setting freq size depending on how many pilots in game</a>
 
c) <a href="#15c">Tracking kills and announcing when pilot gets 10 kills in a row without dying </a>
 
d) <a href="#15d">Warp pilot to coord when they are in a certain region</a>
 
e) <a href="#15e">Structures within structures</a>
 
f) <a href="#15f">Tracking flag data</a>
 
g) <a href="#15g">Example way to do simple /!spam feature</a>
 
h) <a href="#15h">Example of implementing a simple stack to do "next in line for several 'boxes' at once"</a>
 
i) <a href="#15i">Example of reading any text from a .txt and printing it to pilot line by line</a>
 
j) <a href="#15j">Example of printing player stats grid</a>
 
k) <a href="#15k">Example of checking if any pilots are within a region</a>
 
l) <a href="#15l">Example of functions to get a pilot's struct id info from a name or *player info</a>
 
m) <a href="#15m">Example of creating a logfile name using date and squad names</a>

 
n) <a href="#15n">Sending messages to playing freqs or public and logging depending on status</a>
 
o) <a href="#15o">Example of reading in all player/freqs to struct data</a>
 
p) <a href="#15p">Example of finding MVP from struct data</a>
 
q) <a href="#15q">Print time stamp of event</a>
 
r) <a href="#15r">Simple way to track player bomb/bullet damage stats</a>
 
s) <a href="#15s">Simple way to print those stats</a> 
t) <a href="#15t">Make bot spectate specific coordinates</a>
 
</blockquote>
</blockquote>
 

<hr width="500" size="1" /> 
 
<a name="0"></a>
[0] Setting up a MERVBot bot (plugin) 

<blockquote>MERVBot download site:  <a href="http://catid.sscentral.com">http://catid.sscentral.com</a>
 
 
MERVBot Forum:  <a href="http://www.ssforum.net">http://www.ssforum.net</a>
 (Development - MervBot forum) 
 
1) Download <a href="http://catid.sscentral.com/files/MERVBot.zip">MERVBot Build 37 (DLL 6.5)</a>
 
<blockquote>Unzip MERVBot.zip into a new folder. (example c:program filescontinuummervbot) 
Unzip src.zip into "/src" subfolder of that new folder (example c:program filescontinuummervbotsrc) 
</blockquote>
2) Download <a href="http://catid.sscentral.com/files/Tutorial.zip">DLL-plugin Tutorial</a>
 
<blockquote>
 Unzip Tutorial.zip into "/tutorial" subfolder of that new folder. (example c:program filescontinuummervbotsrctutorial) 
(note spawn.h, spawn.cpp, and command.cpp are here) 
<blockquote>File descriptions: 
</blockquote>
 <blockquote>
spawn.h = declare/initialize globals 

command.cpp = code for commands coming into bot (ie /!help, /!play, etc) 

spawn.cpp = code for main part of bot 
</blockquote>
 </blockquote>
 <blockquote>Note: if you only want to execute someone's premade
bot (.dll), skip to step 4 (Run your bot .dll), otherwise continue to learn
how to make your own bot 
</blockquote>
3) Microsoft Visual c++ 
<blockquote>1) Start Visual Studios 6.0 
 

2) Click the Drop Down Menu labbled "File" at the top left of your screen 
 

3) Click "New" 
 

4) On the next screen that comes up, choose from the Project tab, then Win32 Dynamic-Link Library 
 

5) Select the "/src" folder as the base folder (example c:program filescontinuummervbotsrc) 
 

6) Name your project "mybot". This will make a "mybot" subfolder in your "src" folder. Click OK 
(example creates c:program filescontinuummervbotsrcmybot) 
 

7) Choose to create an "Empty DLL project" 
 

8) Click "Finish" 
 

9) Click the Drop Down Menu labbled "Project" 
 

10) Click "Add To Project Files" 
 
11) Copy only spawn.h, spawn.cpp, and command.cpp from the "tutorial" folder into the this new folder. 
(example from c:program filescontinuummervbotsrctutorial to c:program filescontinuummervbotsrcmybot) 
 
12) Click the Drop Down Menu labelled "Build" 
 

13) Click "Build (dll name)" - where the (dll name) is "mybot" 
 

14) Go into your "mybot" folder and look for a folder named "Debug" 
(example c:program filescontinuummervbotsrcmybotdebug) 
 

15) Your new DLL will be in that folder. (example mybot.dll) 
 
16) Copy mybot.dll to your base folder that has mervbot.exe in it (example c:program filescontinuummervbot) 
</blockquote>

 4) Run your bot dll: 
<blockquote>To run your bot you need your .dll (mybot.dll), Commands.txt, MERVBot.exe,
MERVBot.ini, Operators.txt, Spawns.txt, subspace.bin, and zlib.dll all in
one folder (example c:program filescontinuummervbot) 
</blockquote>
 <blockquote>
 Edit spawns.txt (only one line of text in file needed) 

<blockquote>bot_name : pw_for_bot_name : arena: dll_plugin : optional_staff_password 
<blockquote>
Example: 2v2-Bot-League : botpw: 2v2a: 2v2league : staffpw 
 
- You should create your bot name and pw using your Continuum client as you would create any new name. 
 
- There is no * in front of staffpw. 
 
- Bot needs to be on vip.txt or have moderator+ access to enter a zone. 

</blockquote>
 </blockquote>

Edit MERVBot.ini 

<blockquote>[Login] 
Zone=216.33.98.254:21000    // make that your zone IP:PORT available from zone.dat in Continuum dir 
</blockquote>


Edit operators.txt 
<blockquote>
 access_level : name : 

<blockquote>Example:   

4:my_name: 

4:another_sysop: 

3:other_person: 

</blockquote>
 <blockquote> </blockquote>

 </blockquote>

 Run MERVBot.exe 
<blockquote>
 Double click MERVBot.exe, the bot should now enter the zone 
</blockquote>
 </blockquote>
 </blockquote>
 <blockquote>
 <blockquote>Modify your MERVBot code 
<blockquote>You can open your MERVBot project by opening "mybot.dsw" file with visual c++ 
(example c:program filescontinuummervbotsrcmybotmybot.dsw) 
 
Edit the spawn.h, spawn.cpp, and command.cpp to create your bot, then build,
copy your updated dll to your MERVBot.exe folder and then execute the bot. 
 
Use the tutorial to get ideas on how to implement certain types of features into the bot. 
</blockquote>
 </blockquote>
 </blockquote>
 
<a name="1"></a>
[1] Player Commands - (command.cpp) 
<blockquote>
 <div align="left">This section describes how to implement player commands into MERVBot 
(example: if you want /!test to make the bot respond with "hi") 
 
In command.cpp 
<blockquote>void botInfo::gotCommand(Player *p, Command *c) { 
    switch (p->access) { 
        case OP_Player: 
        { 
            if (c->check("test")) 
            { 
            sendPrivate(p,"hi"); 
            } 
        } 
</blockquote>
You just put your player command where 'test' is, then what you want that command to do. 
If you want the command to be for moderators you put it in the OP_Moderator section instead 
<blockquote>case OP_Moderator: 
{    // Moderator-level commands 
} 
</blockquote>
            // Note: Moderators
can do Player commands, SuperModerator can do Moderator and Player commands,
etc 
 
How to have commands with numerical input - (ie !test 1) 
<blockquote>        if (c->check("test")) { // reads in test #, default to 1 if invalid number input 
 
        int temp = 1; 
 
        if (isNumeric(c->final)) 
            temp = atoi(c->final); 
</blockquote>
 
How to have player name as input - (ie !rank player) 
<blockquote>    if (c->check("rank")) { 
 
        String player_name = c->final; 
 
        if (player_name.IsEmpty())    // default name to self if invalid name 
            player_name = p->name; 
</blockquote>
 
How to have complicated input - (ie !squads squadA vs squadB _OR_ !squads teamA:squadA:teamB:squadB) 
 
        you parse the c->final message
looking for identifiers, then divide the string to get the values 
 
            else if (c->check("squads")) 
            { 
                strncpy(squadA, "", 20); 
                strncpy(squadB, "", 20); 
 
                char s[256]; 
                strncpy(s,c->final,255); 
 
                int l= strlen(s) - 1; 
 
                for (int i=0; i<l; i++) 
                { 
                    // team1 vs team2 
                  
 if ((s[i]==' ') && (s[i+1]=='v') && (s[i+2]=='s') &&
(s[i+3]==' ')) 
                    { 
                      s[i]=0; 
                      strncpy(squadA, s,20); 
                      s[i]=' '; 
                  
   strncpy(squadB, &(s[i+4]),20); 
                      break; 
                    } 
                     
                    // freq1:team1:freq2:team2 
                    if (s[i] == ':') 
                    { 
                        char s2[256]; 
                  
     teamA = atoi(s); 
                  
     strncpy(s2,&(s[i+1]),255); 
 
                  
     for (int j=0; j < strlen(s2); j++) 
                  
         if (s2[j] == ':') 
                  
         { 
                  
             char s3[256]; 
 
                  
             s2[j]=0; 
                  
             strncpy(squadA,s2,20); 
                  
             s2[j]=':'; 
                  
              
                  
             strncpy(s3,&(s2[j+1]),255); 
 
                  
             for (int k=0;
k<strlen(s3); k++) 
                  
               
 if (s3[k]==':') 
                  
               
 {              
      
                  
               
     teamB = atoi(s3); 
                  
               
     strncpy(squadB,&(s3[k+1]),20); 
                  
               
     break; 
                  
               
 } 
                  
             break; 
                  
         } 
                        break; 
                    } 
                 } 
</div>
 </blockquote>
 <blockquote>// Example of a help menu (!help) spawn.h 
<blockquote>void botInfo::gotHelp(Player *p, Command *c) 
{ 
    if (!*c->final) 
    { 
        sendPrivate(p, "4v4 Bot General Commands:"); 
        sendPrivate(p, "------------------------"); 
        sendPrivate(p, "!caps              
- get captain names"); 
        sendPrivate(p, "!roster <squad>     - get roster of a squad"); 
        sendPrivate(p, "!schedule          
- get current schedule");         sendPrivate(p,
"!score             
- get current score"); 
                
</blockquote>
 </blockquote>
<a name="2"></a>
[2] Event Call Descriptions - in spawn.cpp 
<blockquote>MERVBot is event based, so when making a bot you need to decide what will happen at certain events 
Normal plugins need to consider what happens when bot enters arena, player enters arena, player leaves arena, 
player events like kill, shipchange, teamchange, spec, move then any other relevent events to your bot 
just worry about events that are relevent to the tasks your bot is doing 
 
// Timer 

case EVENT_Tick:      - called 1x/sec, decrementing each countdown[n] by 1, use for time triggered events 
 

// Arena Events 

case EVENT_ArenaEnter:         - called when bot enters arena 

case EVENT_ArenaSettings:     - called when bot gets arena settings 

case EVENT_ArenaLeave:        - called when bot exits arena 

case EVENT_ArenaListEntry:     - called when bot gets an entry from the arena list (esc-a) 

case EVENT_ArenaListEnd:     - called when bot reads last entry of arena list (esc-a) 
 

// Flag Events 

case EVENT_FlagGrab:        - called when a pilot picks up a loose flag 

case EVENT_FlagDrop:        - called when a pilot drops a flag (timer runs out) 

case EVENT_FlagMove:        - called when a flag moves 

case EVENT_FlagVictory:        - called when a team wins flag game (gets all flags) 

case EVENT_FlagReward:        - called when theres a periodic flag reward given 
 

// Timed Game 

case EVENT_TimedGameOver:    - called when a timed game is over (like speed zone game) 
 

// Soccer 

case EVENT_SoccerGoal:        - called when a soccer goal is scored 

case EVENT_BallMove:        - called when a soccer ball moves 
 

// Receive file 

case EVENT_File:        - called when a file is received (*getfile) 
 

// Player events 

case EVENT_PlayerEntering:    - called when a pilot enters the arena 

case EVENT_PlayerMove:        - called when a pilot's ship moves 

case EVENT_PlayerWeapon:    - called when a pilot fires a weapon 
case EVENT_WatchDamage:        - called when
a pilot takes damage (bot must have /*watchdamage on for them) 

case EVENT_PlayerDeath:        - called when a pilot dies 

case EVENT_PlayerScore:        - called when a pilot changes their score (?scorereset) 

case EVENT_PlayerPrize:        - called when a pilot gets a prize (green) 

case EVENT_PlayerShip:        - called when a pilot ship changes 

case EVENT_PlayerSpec:        - called when a pilot spectates 

case EVENT_PlayerTeam:        - called when a pilot changes freqs 

case EVENT_PlayerLeaving:    - called when a pilot exits arena (esc-q, ?go <arena>, or lagout) 
 

// Bot events 

case EVENT_SelfShipReset:    - called when bot's ship gets reset 

case EVENT_SelfPrize:        - called when bot gets a prize (green) 

case EVENT_SelfUFO:        - called when bot toggles UFO mode 

case EVENT_PositionHook:    - called when "Core is requesting the DLL to send a position packet" 
 

// Brick 

case EVENT_BrickDropped:    - called when a pilot uses a brick 
 

// Objects 

case EVENT_ObjectToggled:    - called when a .lvz object is toggled on/off 
 

// Turrets 

case EVENT_CreateTurret:    - called when a pilot attaches to another pilot (f7) 

case EVENT_DeleteTurret:    - called when a pilot detaches from a turret 
 

// Messages 

case EVENT_Chat:        - called when bot gets a chat message 

case EVENT_LocalCommand:    - called when bot gets a player command from arena 

case EVENT_LocalHelp:        - called when bot gets a player !help command 

case EVENT_RemoteCommand:    - called when bot gets a command from outside arena 

case EVENT_RemoteHelp:        - called when bot gets a player !help command from outside arena 
 

case EVENT_Init:        - called when DLL is loaded 

case EVENT_Term:        - called when DLL is unloaded 
</blockquote>
 
<a name="3"></a>
[3] Messaging - How to use the messaging system 

<blockquote>Private message - void sendPrivate(Player *player, char *msg); 
<blockquote>Examples: 
a) sendPrivate(p,"hi"); 
b) String s="test"; sendPrivate(p,s); 
c) String s="test"; s += "ing"; sendPrivate(p,s); 
</blockquote>
 <blockquote>d) char captain1[20]; char captain2[20]; 
strncpy(captain1,"",20); strncpy(captain2,"",20); 
sendPrivate(p,(String) captain1 + " and " + (String) captain2 + " are the captains."); 
</blockquote>
 <blockquote>
 </blockquote>

 <blockquote>Team message - void sendTeamPrivate(Uint16 team, char *msg); 
<blockquote>Examples: 
a) sendTeamPrivate(8025,"hi spec freq"); 
b) Uint16 test=0; sendTeamPrivate(test,"hi freq 0"); 
</blockquote>
 </blockquote>
 <blockquote>Public message - void sendPublic(char *msg); 
<blockquote>Example: sendPublic("*arena " + (String) p->name + " is now a captain"); 
</blockquote>
Chat channel message - void sendChannel(char *msg); 
<blockquote>Example: sendChannel("hi chat channel"); 
</blockquote>
Remote private message - void sendRemotePrivate(char *name, char *msg); 
<blockquote>Example: sendRemotePrivate("Player01", "hi"); 
</blockquote>
 </blockquote>
 <blockquote>Note: to have bot print several lines of text fast it needs sysop in the
arena (sysop in arena bot first spawns to also) otherwise it'll print slow to avoid being
kicked for spam 
</blockquote>

 
<a name="4"></a>
[4] Timer - How to use the timing function 

<blockquote>Setup number of timers and initialize: 
<blockquote>// spawn.h - specify how many timers 
</blockquote>
 <blockquote>class botInfo 
{ 
int countdown[10];   // this gives you 10 timers</blockquote>
 <blockquote> // spawn.h - initialize timers 
     
        public: 
        botInfo(CALL_HANDLE given) 
        { 
        countdown[0] = 0; 
        countdown[1] = 60; // 60 seconds 
        // 
        // initialize values 
        // 
        countdown[9] = 5*60; // 5 minutes 
</blockquote>
 Using timer functions: 
<blockquote>   // in spawn.cpp 
 
    case EVENT_Tick: 
    { 
        for (int i = 0; i < 10; ++i) 
            --countdown[i]; 
 
        if (countdown[1] == 2) // when timer #1 hits two seconds 
        { 
        // do stuff here when timer #1 hits 2 seconds 
        // example: sendPublic("two seconds left, setting timer to 1 minute"); 
        // example: countdown[1] = 60;  // change timer #1 value 
        } 
</blockquote>
 <blockquote>    Notes:  - In the "for" loop, you want "i < 10" to be the number of timers from spawn.h 
        - The timer is in seconds. EVENT_Tick is called once per second. 
        - The timers decrease by one each second down, not stopping at 0. 
 
        - You can change the value of the countdown[n]'s in other parts of the program 
        (ie.  case EVENT_PlayerDeath: { countdown[1] = 45;  // set timer #1 to 45 sec 
        everytime someone dies) 
</blockquote>
 </blockquote>

 
<a name="5"></a>
[5] Writing Functions 
<blockquote><blockquote>Write your function in spawn.cpp at top of file in the //////// DLL "import" //////// section
<blockquote>    //////// DLL "import" //////// 
 

    bool closeto(Player *p, int x, int y, int tolerance)  // note uses abs() function declared elsewhere 
    { 
            // return if player
p is in area of square with center x,y and radius = tolerance 

        return (abs((p->tile.x) - x) <
tolerance) && (abs((p->tile.y) - y) < tolerance); 

                } 
</blockquote> If
you want your function to have access to data from the spawn.h botInfo section 
<blockquote>public: 
    botInfo(CALL_HANDLE given) 
    { 
 
   // then you need to make your spawn.cpp function in the format: 
 
        bool botInfo::closeto(Player *p, int x, int y, int tolerance) 
        { 
          // function here 
         } 
 
Include function in spawn.h at bottom of file with the other functions 
<blockquote>    public: 

    botInfo(CALL_HANDLE given) 

    { 

    } 
 

    bool closeto(Player *p, int x, int y, int tolerance); 
     // your new function. note: w/o botInfo keyword and with a ; 
 

    void clear_objects();  // functions already there 

    void object_target(Player *p); // functions already there</blockquote>

 </blockquote>
 </blockquote>
 <blockquote>Pass values by reference
<blockquote>bool botInfo::closeto(Player *p, int& x, int y, int tolerance)  // note the & 
 
bool is_close = closeto(p,x,y,tolerance);  // if x is changed in closeto() its saved here 
</blockquote>
 </blockquote>

 <blockquote>Pass array as parameter 
<blockquote>int freqs[5]; 
 
my_function(freqs);  // call function - notice freqs and not freqs[5] or freqs[] 
 
void my_function(int freqs[]) {}  // function - notice freqs[] and not freqs[5] or freqs 
</blockquote>
 </blockquote>
<a name="6"></a>
[6] Cycling players- How to search through the players in the arena 
<blockquote>    _listnode <Player> *parse = playerlist->head; 
     
    while (parse) 
    { 
        Player *p = parse->item; 
 
        // do functionality here 
        // Example 1: sendPrivate(p,"*watchdamage"); // turns on all pilot's watchdamage 
        // Example 2: if (p->safety != 0)
sendPrivate(p,"*spec"); // spec all pilots in safe zone 
 
        parse = parse->next 
      } 
</blockquote>
 
<a name="7"></a>
[7] Checking if pilot is in a safe zone 
<blockquote>    if (p->safety != 0)  // pilot is in a safe zone 
    if (p->safety == 0)  // pilot is NOT in a safe zone 
 
    To detect a pilot entering a safe zone do: 
 
        case EVENT_PlayerMove: 
        { 
            if (p->safety != 0) 
</blockquote> 
<a name="8"></a>
[8] Random number 
<blockquote>Method 1 (completely random) 
<blockquote>    #include "time.h" 
 
    srand(time(NULL)); 
    rand(); 
    int temp = (int) (51 * ((float)rand()/RAND_MAX));  // returns a random integer between 0 and 51 
</blockquote>
 
Method 2 (random pilot in arena) 
<blockquote>    #include <stdlib.h> 
 
    int temp = GetTickCount() % getIngame();  // getIngame() = how many pilots in arena 
 
    _listnode <Player> *parse = playerlist->head; 
    while (parse) 
    { 
        Player *p = parse->item; 
 
        if (p->ship != SHIP_Spectator){  // if not in spec 
        if (!(--temp) {  // decrement temp, if its 0, make this pilot rabbit 
            rabbit = p; 
            break; 
            }} 
    parse = parse->next; 
    } 
</blockquote>
 </blockquote>
 
<a name="9"></a>
[9] Tracking time not using countdown[n] 
<blockquote>    #include <stdlib.h> 
 
    int temp = GetTickCount(); // get time stamp 
    // later in program 
    temp = (GetTickCount() - temp)/1000; // how many seconds have passed 
</blockquote>
 
<a name="10"></a>
[10] Storing data for pilots 
<blockquote>There are several ways to store data for pilots (ie tracking flagtime or kills in a period of time) 
 
1) get/setTag - use if you only want to track data until pilot leaves arena then its erased 
built in tags track by an ID that is reset when pilot leaves/enters arena, so loses track of data once they leave arena 
 
2) modified perm get/setTag - use if you want to track all pilots even if they leave (advantage - easier to sort by player) 
also can track near unlimited amount of pilots 
 
3) structs - use to track all pilots even if they leave, (advantage -
easier to sort by freqs), have to specify bound of players 
 
note: 2 and 3 are similar in effect, mostly the difference is in how you are able to search through data 
you need to decide which method of storing data is best for each bot depending on what it does 
beware using modified perm get/setTag if bot is in an arena for long periods
of time, data is not reset so the linkedlist could get huge 
 

// initialize values in spawn.h at very top 
 
1) Built in get/setTag method</blockquote><blockquote><blockquote>    #define DMG_DEALT        0 
    #define DMG_TAKEN        1 
 
    // in spawn.cpp initialize the values on arena-enter and player-enter 
     
        case EVENT_ArenaEnter: { 
 
            _listnode <Player> *parse = playerlist->head; 
 
            while (parse) // do for all pilots in arena when bot enters 
            { 
                Player *p = parse->item;  // get pilot 
 
                set_tag(p, DMG_DEALT, 0); // initialize to 0 
                set_tag(p, DMG_TAKEN, 0); 
             
                sendPrivate(p,"*watchdamage"); 
// optionally turn on player *watchdamage 
 
                parse = parse->next;  // get next pilot 
                } 
            } 
 
        case EVENT_PlayerEntering: { 
 
            set_tag(p, DMG_DEALT, 0); // initialize to 0 
            set_tag(p, DMG_TAKEN, 0); 
 
            sendPrivate(p,"*watchdamage"); 
 
    // then somewhere edit the tag values 
 
        case EVENT_WatchDamage:  { 
 
            // sets tag for k (shooter) to be old value plus damage dealt currently 
            set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT) + damage); 
 
 // how to retrieve the tag values 
 
        // as a command in spawn.h 
 
        else if (c->check("showstats")) { 
 
            int temp = get_tag(p, DMG_TOTAL_DEALT); 
 
            String s = "You've done "; 
            s += temp; 
            s += " damage so far!"; 
 
            sendPrivate(p,s); 
 
    // kill tags when player leaves arena 
 
        case EVENT_PlayerLeaving: { 
 
            killTags(p); 
</blockquote>2) Modified permanent get/setTag method 
<blockquote>// same as get/setTag with some modifications to the tag code, then can use tags exactly as above 
 
// spawn.h, add char name[20]; into struct PlayerTag 
<blockquote>struct PlayerTag 
{ 
    Player *p; 
    char name[20]; 
    int index; 
    int data; 
}; 
</blockquote>
// spawn.cpp, modifications 
<blockquote>case EVENT_PlayerLeaving: 
        { 
            Player *p = (Player*)event.p[0]; 
 
            // killTags(p);  // remove so tag not deleted on arena exit 
 
</blockquote>
 <blockquote>int botInfo::get_tag(Player *p, int index) 
{ 
    _listnode <PlayerTag> *parse = taglist.head; 
    PlayerTag *tag; 
 
    while (parse) 
    { 
        tag = parse->item; 
 
        // if (tag->p == p) 
        if (strcmp(tag->name,p->name)==0)  // now tracking by player name, not ID 
        if (tag->index == index) 
            return tag->data; 
 
        parse = parse->next; 
    } 
 
    return 0; 
} 
 
void botInfo::set_tag(Player *p, int index, int data) 
{ 
    _listnode <PlayerTag> *parse = taglist.head; 
    PlayerTag *tag; 
 
    while (parse) 
    { 
        tag = parse->item; 
 
        //if (tag->p == p) 
       if (strcmp(tag->name,p->name)==0) // now tracking by player name, not ID 
        if (tag->index == index) 
        { 
            tag->data = data; 
            return; 
        } 
        parse = parse->next; 
    } 
 
    tag = new PlayerTag; 
    // tag->p = p; // not tracking by ID anymore 
    strncpy(tag->name, p->name, 20); // tracking by player name 
    tag->index = index; 
    tag->data = data; 
    taglist.append(tag); 
}</blockquote>
 </blockquote>
3) Using Struct's 
<blockquote>struct name                     
    {              
                  
 

    // variables                   

    }; 
 
// Example: (in spawn.h) 
<blockquote>class botInfo 
{ 
 
struct freqdata { 
int kills; 
 int deaths; 
}; 
 
freqdata freqs[100]; // 100 of those structs 
 
// then access it in spawn.cpp using 
freqs[56].kills = 1; 
</blockquote>
 </blockquote>
 
</blockquote>
 <a name="11"></a>
[11] Output of data/messages 
 
    using normal Strings 
 
        // does *arena X pilots left in the game. 
 
         String s = "*arena "; 
         s += temp;  // some variable (int) 
         s += " pilots left in the game."; 
         sendPublic(s) 

<blockquote>OR 

</blockquote>
 <blockquote>sendPublic("*arena " + (String) temp + " pilots left in the game."); 

</blockquote>

 
    example using sprintf to align/space data 
 
            // output data
will be in this approximate format (not lined up perfectly because of html) 
 
            //
---------------------------------------------------------------------------------------- 
            // Squad: squadname      
PTS     FPTS    K    D  DMG DEALT
TAKEN   F  FK    FLT       
     // ---------------------------------------------------------------------------------------- 
            //
PlayerA          
         10000        500
116 101               
9999    99999 10 150 980:55           
 // PlayerB              
         500       
200     7     5     
          9999    99999  5  
   3     0:04 
 
            char str[255]; 
            sendPublic("*arena----------------------------------------------------------------------------------"); 
            sprintf(str, "*arena
Squad: %-20s   PTS     FPTS   K  
D  DMG DEALT  TAKEN  F  FK    FLT",freqs[freq].freqname); 
            sendPublic(str); 
            sendPublic("*arena----------------------------------------------------------------------------------"); 
 
            // assuming existing freqs struct with data 
            for (pilot=freqs[freq].playercount-1; pilot>=0; pilot--) 
            { 
                // on freq squad so print stats 
                char outString[255]; 
 
                sprintf(outString,
"*arena %-20s %12d %8d %3d %3d %10d %6d %2d %3d %3d:%02d",freqs[freq].pilots[pilot].name, 
                freqs[freq].pilots[pilot].points,
freqs[freq].pilots[pilot].flagpoints, freqs[freq].pilots[pilot].kills, 
                freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].dmgdealt, freqs[freq].pilots[pilot].dmgtaken,freqs[freq].pilots[pilot].flags, 
               
 freqs[freq].pilots[pilot].flagkills, freqs[freq].pilots[pilot].flagtime
/60, freqs[freq].pilots[pilot].flagtime %60); 
                 
                sendPublic(outString); 
            } 
 
            // Notes: sprintf
format = sprintf(output char string, spacing, variables) 
            // Notes: s = chars, d = integer, - = left align, right align default 
            // Notes: doing
%02d = put 0 in front if not 2 digits, %3d:%02d makes 0:04 format 
 
 
<a name="12"></a>
[12] Input/Output to files 
<blockquote>Input to file 
<blockquote>// example reading from duel.ini looking for line that starts with MaxBoxes= then taking the next char as value to store as 
// MAX_BOXES (ie duel.ini = MaxBoxes=5) 
#include <fstream> 
using namespace std; 
 
ifstream file("duel.ini"); 
    char line[256]; 
 
    // read in MaxBoxes=X 
    while (file.getline(line, 256)) 
    { 
        if (CMPSTART("MaxBoxes=", line)) 
        { 
            MAX_BOXES = atoi(&(line[9])); 
            break; 
        } 
    } 
</blockquote>
Output to file 

<blockquote>// normal char output 

<blockquote>#include <fstream> 

using namespace std; 

 

ofstream file("duelleaguestat.inc", ios::app);   // app = put all data at end of file 

 

file << squad1<< endl;  // squad1 = char[20] 

file << " vs "<< endl; 

file << squad2<< endl;  // squad2 = char[20] 

</blockquote>

// how to output String's
to file (key is converting String to (char*) to file write) 

<blockquote>
String str = freqs[freq].slotname[slot]; 

str += ", Repels: " + (String)(int) t->repel; 

               
               
    

outf << endl; 

outf << (char*) str; 

</blockquote>

 
// date and time stamp 

<blockquote>#include "time.h" 
 
char u[100]; 
time_t t=time(NULL); 
tm *tmp = localtime(&t); 
strftime(u,99,"%c",tmp); 
sendPublic("Date and time: " + (String) u); 

</blockquote>
 </blockquote>
</blockquote>
 <blockquote>Example reading input from file using "GetPrivateProfileString" (from rampage plugin) 
<blockquote>format of rampage.ini 
<blockquote>7=is on a killing spree! (6:0) 10=is opening a can of whoop-ass! (9:0) 
</blockquote>
read input 
<blockquote>rampageini.h 
<blockquote>#pragma once 
#ifndef RAMPAGEINI_H 
#define RAMPAGEINI_H 
 
#define NUM_RANKS 10 
#define BUFFER_LEN 256 
 
struct RampageSettings 
{ 
    char quotes[NUM_RANKS][BUFFER_LEN]; 
}; 
 
void LoadSettings(RampageSettings &setts); 
 
#endif    // RAMPAGEINI_H 
</blockquote>
rampageini.cpp 
<blockquote>#include "rampageini.h" 
static char buffer[BUFFER_LEN]; 
static char path[BUFFER_LEN]; 
#include "../algorithms.h" 
#define WIN32_LEAN_AND_MEAN 
#include <windows.h> 

 
char *rank_type[10] = { 
    "7", 
    "10", 
}; 
 
void LoadSettings(RampageSettings &setts) 
{ 
    GetCurrentDirectory(BUFFER_LEN - 64, path); 
    strcat(path, "\rampage.ini"); 

 
    for (int i = 0; i < NUM_RANKS; ++i) 
    { 
        GetPrivateProfileString("Comments",
rank_type[i], "-ERROR-", setts.quotes[i], BUFFER_LEN, path); 
    } 
} 
</blockquote>
 </blockquote> </blockquote> </blockquote>
<a name="13"></a>
[13] Simple programming commands 

<blockquote>simple commands     

<blockquote>
    declare/initialize variables   // example:  int
temp;  int temp2 = 1;  temp2 = 3;   
                     
                     
// bool check = true; check = false; 

 
    if (condition) {}          
     // example: if (a > b) { a++; } 

 

    if (condition) {} else {}       
     // example: if (b <= 0) { b--; } else { a++;
} 

 

    while (condition) {}          
     // example: while (b > 0) { b--; } 

 

    for (initialize; condition; increment){}  
 // example: for (a=1; a < 10; a++) { a = a + b; } 

</blockquote>

 array 

<blockquote>single dimension 

<blockquote>int teams[100];   // create 100 hundred teams 0-99 

 
teams[50] = 1; 

</blockquote>
multi-dimensional 

<blockquote>int teams[100][50];  // multidimensional arry 

 
teams[99][49] = 2; 

</blockquote>
variable size 

<blockquote>String *list = new String[amount+1]; // string array with size amount (variable) + 1; 

 
list[amount-1] = "hi"; 

</blockquote> </blockquote>
struct     

<blockquote>    struct name          
          

    {              
                  
  

    // variables          
       

    }; 

<blockquote>// example: 
struct freqdata {
int kills; int deaths; }; 

 
freqdata freqs[100]; // 100 of those structs 

 
freqs[56].kills =
1;  // access struct 

</blockquote> </blockquote>

 switch     

<blockquote>switch (variable)          
   

    {              
                  
   

        case n:      
                

        { }          
               
    

        break;      
                  

                  
                 
      

        case m:      
              

        {  }       
                 
  

        break;      
              

         

        default: 

        break; 

    } 

<blockquote> <blockquote>// Example: 
switch (p->ship) { 

 
    case SHIP_Warbird:  { 
        sendPrivate(p,"You're in a warbird"); 
        }  break; 

 
        default: 
            break;</blockquote> </blockquote>

 </blockquote>
 </blockquote>

 
<a name="14"></a>
[14] Useful Player data 
<blockquote>

// useful data stored
by MervBot about each player (player.h) 

 

p->name = player name stored as char[20] 
p->squad = player squad stored as char[20] 
p->ship = ship (0-7) enumerated as SHIP_Warbird, SHIP_Spectator, etc.. 
p->safety = if ship is in safety zone (boolean) 
p->bounty = player bounty 
p->energy = player energy (have bot with *energy on to get accurate readings) 
p->flagCount = how many flags player is holding 

p->team = player frequency 
p->(burst, repel, thor, brick, decoy, rocket, portal) = how many items of that type player has 
p->(stealth, cloak, xradar, awarp, ufo, flash, safety, shields, supers) = if player has that item on (boolean) 

p->score.killPoints = player kill points 
p->score.flagPoints = player flag points 
p->score.wins = player kills from f2 
p->score.losses = player deaths from f2 
</blockquote>
 
 
<a name="15"></a> [15] Bot built in functions 

<blockquote>// useful MervBot commands to control what the bot is doing 
 
// player.cpp 
Player::move(Sint32 x, Sint32 y)  // example  me->move(512,512) - bot moves to coord 512 512 
Player::clone(Player *p) // example  me->clone(p) 
 
// dllcore.cpp (descriptions of functions in dllcore.h) 
 
BotEvent makeEcho                (char *m); 
BotEvent makeSay                (int t, int s, int i, char *m); 
 
BotEvent makeShip                (int s); 
BotEvent makeTeam                (int t); 
BotEvent makeGrabFlag            (int f); 
BotEvent makeSendPosition        (bool reliable); 
BotEvent makeDropFlags            (); 
 
BotEvent makeDeath                (Player *p); 
BotEvent makeAttach                (Player *p); 
BotEvent makeDetach                (); 
BotEvent makeFollowing            (bool f); 
BotEvent makeFlying                (bool f); 
BotEvent makeBanner                (BYTE *b); 
BotEvent makeDropBrick            (); 
BotEvent makeFireWeapon            (void *weapon_info); 
 
BotEvent makeToggleObjects        (Uint16 player, Uint16 *objects, int num_objects); 
 
BotEvent makeSpawnBot           
(char *name, char *password, char *staff, char *arena); 
BotEvent makeChangeArena        (char *name); 
BotEvent makeChangeSettings        (_linkedlist <String> *settings); 
 
// example how to use them: 
 
tell(makeFollowing(false)); 
 
// look in Commands.txt , command.cpp (core), or /!help to bot to see all bot external commands (example /!go <arena>) 
</blockquote>
 
Example Code 
 
<a name="15a"></a>
a) No antiwarp in center of map (take green away and warn) 

<blockquote>// using function closeto() and abs() </blockquote> <blockquote>bool closeto(Player *p, int x, int y, int tolerance) { 
    return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); } 
inline int abs(int n) { 
    if (n < 0)    return -n; 
    else        return n; } 
radius = 35;  // global variable </blockquote> <blockquote>case EVENT_PlayerMove: { 
            Player *p = (Player*)event.p[0]; 
            // no anti in center 
            if ((p->ship != SHIP_Spectator) && (p->awarp)) { 
                if (closeto(p, 512, 512, radius)){ 
                    sendPrivate(p, "*prize #-20"); 
               
    sendPrivate(p, "*warn Antiwarp is not allowed in center."); 
                } 
            } </blockquote>


<a name="15b"></a>

b) Setting freq size depending on how many pilots in game 

<blockquote>case EVENT_Tick:  { <blockquote>if (countdown[0] == 0) {     // assuming countdown[0] initialized to > 0  in spawn.h, freqchange=0; </blockquote>
               
_listnode <Player> *parse = playerlist->head; 
                int count = 0; 
                while (parse) 
                { 
                    Player *p = parse->item; 
                    if (p->ship != SHIP_Spectator) 
                    ++count; 
                    parse = parse->next; 
                } 
                if ((count > 24) && (freqchange != 4)) 
                { 
               
    sendPublic("?set team:maxperteam:4"); 
                    String s; 
                    s = "Max freq size 4  ("; 
                    s += count; 
                    s += " pilots in game)"; 
                    sendPublic(s); 
                    freqchange = 4; 
                } 
               
if ((count < 25) && (count > 14) && (freqchange !=
3)) 
                { 
               
    sendPublic("?set team:maxperteam:3"); 
                    String s; 
                    s = "Max freq size 3  ("; 
                    s += count; 
                    s += " pilots in game)"; 
                    sendPublic(s); 
                    freqchange = 3; 
                } <blockquote>countdown[0] = 120; 
} </blockquote></blockquote>

<a name="15c"></a> c) Tracking kills and announcing when pilot gets 10 kills in a row without
dying

<blockquote>case EVENT_PlayerDeath:  { <blockquote>// assuming tags are setup (see storing data section) 
set_tag(p,KILLS, 0);  // pilot died, reset to 0 kills in a row 
set_tag(k, KILLS, get_tag(k, KILLS) + 1);  // pilot killed someone, increment kills in a row by 1 
if (get_tag(k,KILLS) == 10)  sendPublic("*arena (String) k->name + " has gotten 10 kills.");</blockquote></blockquote>


<a name="15d"></a>

d) Warp pilot to coord when they are in a certain region 

<blockquote>// using functions closeto() and abs() 
bool closeto(Player *p, int x, int y, int tolerance) { 

    return (abs((p->tile.x) - x) < tolerance) && (abs((p->tile.y) - y) < tolerance); } 

inline int abs(int n) { 

    if (n < 0)    return -n; 

    else        return n; } 
case EVENT_PlayerMove:    { 
        if (closeto(p, 509, 509, 2)) {  // if pilot within 2 of map coord 509,509 
            sendPrivate(p, "*warpto 509 504");  // warp to coord 509,504 </blockquote>


 

<a name="15e"></a>

e) Structures within structures (spawn.h botinfo) 

<blockquote>    // Declare in spawn.h <blockquote>    struct playerstats 
    { 
        char name[20]; 
        int kills; 
        int deaths; 
        Uint16 points; 
        Uint16 flagpoints; 
        int flagtime; 
        int cflagtime; 
        int flags; 
        int flagkills; 
        int dmgdealt; 
        int dmgtaken; 
    }; 
    struct freqdata 
    { 
        playerstats pilots[100]; 
        int freqpoints; 
        char freqname[20]; 
        int freqflagpoints; 
        Uint16 freqteam; 
        int freqflagtime; 
        int flags; 
        int kills; 
        int deaths; 
        int flagkills; 
        int dmgdealt; 
        int dmgtaken; 
        int playercount; 
    }; 
    freqdata freqs[100]; </blockquote>
// Initialize in spawn.cpp <blockquote>void botInfo::Clear() 
{ 
    // initialize/clear struct data 
    for (int n=99; n>=0; n--) 
    { 
        freqs[n].freqteam=-1; 
        freqs[n].freqpoints=0; 
        freqs[n].freqflagpoints=0; 
        freqs[n].playercount=0; 
        freqs[n].flags=0; 
        freqs[n].kills=0; 
        freqs[n].deaths=0; 
        freqs[n].freqflagtime=0; 
        freqs[n].flagkills=0; 
        freqs[n].dmgdealt=0; 
        freqs[n].dmgtaken=0; 
        
        for (int m = 99; m>=0; m--) 
        { 
            freqs[n].pilots[m].deaths=0; 
            freqs[n].pilots[m].kills=0; 
            freqs[n].pilots[m].points=0; 
            freqs[n].pilots[m].flagpoints=0; 
            freqs[n].pilots[m].flagtime=0; 
            freqs[n].pilots[m].cflagtime=0; 
            freqs[n].pilots[m].flags=0; 
            freqs[n].pilots[m].flagkills=0; 
            freqs[n].pilots[m].dmgdealt=0; 
            freqs[n].pilots[m].dmgtaken=0; 
        } 
    } 
} </blockquote></blockquote> <blockquote>// Access data in spawn.cpp <blockquote>int freq = p->team; 
freqs[1].pilots[2].kills++; 
OR 
freqs[freq].deaths++; </blockquote></blockquote>

<a name="15f"></a>

f) Tracking flag data 

<blockquote>Example GetPilot() function  (using structs from example e) <blockquote>bool botInfo::GetPilot(Player *p) 
{ 
    // get a pilots freq/pilot id from struct 
    for (freq=freqcount-1; freq>=0; freq--) 
        if (p->team == freqs[freq].freqteam) 
            for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--) 
               
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0) 
                    return true; 
    return false; 
} </blockquote></blockquote> <blockquote>Example way to track flag data using above struct/functions <blockquote>case EVENT_FlagGrab: 
        { 
            if (GetPilot(p))  // function 
            { 
                freqs[freq].pilots[pilot].flags++; 
                freqs[freq].flags++; 
               
if (freqs[freq].pilots[pilot].flags < 2) // didnt have a flag before,
first flag 
               
    freqs[freq].pilots[pilot].cflagtime = GetTickCount();
 // time stamp when picked up flag 
            } </blockquote></blockquote>
 <blockquote>Example way to track flag data using built in get/set tag (from catid flagbot) 

<blockquote>
case EVENT_FlagGrab: 

        { 

            set_tag(p, TAG_STAT_FS, get_tag(p, TAG_STAT_FS) + 1); 

            set_tag(p, TAG_FLAGTIMER, GetTickCount()); 

        } 

</blockquote> </blockquote> <blockquote>Get current flag times using struct format 

<blockquote>void botInfo::SetFlagTimes() 
{ 
    // set current flagtime for pilots/freqs 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
        Player *p = parse->item; 

 
        if (GetPilot(p)) 
            if (freqs[freq].pilots[pilot].flags > 0) 
            { 
                if (PilotOnSquad(p)) 
               
    freqs[freq].freqflagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000; 

 
               
freqs[freq].pilots[pilot].flagtime += (GetTickCount() - freqs[freq].pilots[pilot].cflagtime)/1000; 
               
freqs[freq].pilots[pilot].cflagtime = GetTickCount(); 
            } 

 
        parse = parse->next; 
    } 
} 

</blockquote>
// side note:  case EVENT_FlagDrop: {} gets called anytime theres a teamkill 

</blockquote>

 

<a name="15g"></a>
g) Example way to do simple /!spam feature (allowed 1x/60s) 

<blockquote>declare and initialize variables in spawn.h 

<blockquote>class botInfo 
{ 
bool spamready; 
int SPAM_TIME; 

 
public: 
    botInfo(CALL_HANDLE given) 
    { 
    spamready = true; 
    SPAM_TIME = 60; 

</blockquote>
spawn.cpp - mark as spamready=true when 60 seconds up 

<blockquote>case EVENT_Tick: 
        { 
            if (countdown[0] == 1)  { 
                spamready = true;  // ready to spam again 
            } 

</blockquote>

 
command.cpp - handle !spam command 

<blockquote>case OP_Player: 
{    // Player-level commands 

 
else if (c->check("spam")) 
            { 
               
// zone announcement "Need pilots to duel in ?go arena -pilotname" 
                if (spamready == true) 
                    { 
                    String s; 
               
    s += "*zone Need pilots to duel in ?go "; 
                    s += arena; 
                    s += " - "; 
                    s += p->name; 
                    sendPublic(s); 
                  
                    spamready=false; 
               
    countdown[0] = SPAM_TIME * 60; // next spam time limit 
                    } 
                else if (countdown[0] < 0) 
                { 
               
    sendPrivate(p,"Spam ability disabled."); 
                } 
                else 
                    { 
                    String s; 
                    s += SPAM_TIME; 
               
    s += " Minute timer between announcements. "; 
                    s += countdown[0] / 60; 
                    s += ":"; 
                    if (countdown[0] % 60 < 10) 
                        s += "0"; 
                    s += countdown[0] % 60; 
               
    s += " minutes left before next spam allowed."; 
                    sendPrivate(p, s); 
                    } 
            } 

</blockquote> </blockquote>

<a name="15h"></a>
h) Example of implementing a simple stack to do "next in line for several 'boxes' at once" 

<blockquote>//spawn.h declare variables 

<blockquote>class botInfo 
{ 
Player *next[99][99]; 
int MAX_NEXT; 
int nextcount[99]; 

 
public: 
    botInfo(CALL_HANDLE given) 
    { 
    MAX_NEXT = 8; 

</blockquote>
// spawn.cpp MoveUp function 

<blockquote>void botInfo::MoveUp(int pos, int box) 
{ 
    // moves up the next line for that box and decrement box's nextcount 
    if (nextcount[box] > 0) 
        nextcount[box]--; 

 
    for (pos = pos; pos < MAX_NEXT - 1; pos++) 
    { 
        next[box][pos] = next[box][pos + 1]; 
    } 

 
    next[box][MAX_NEXT] = 0; 
} 

</blockquote>
 </blockquote>


<a name="15i"></a>
i) Example of reading any text from a .txt and printing it to pilot line by line 

<blockquote>#include <fstream> 
using namespace std; 

 
case OP_Player: 
        { 
            if (c->check("schedule")) 
            { 
                // read in schedule from schedule.txt 
                ifstream file("schedule.txt"); 
                char line[256]; 

 
                while (file.getline(line, 256)) 
                { 
                    sendPrivate(p, line); 
                } 
                file.close(); 
            } 

</blockquote>

<a name="15j"></a>
j) Example of printing player stats grid 

<blockquote>// spawn.cpp   (see "structures within structures" example for variable declarations, varibale freqcount = # of freqs) 

 
void botInfo::DisplayPlayers() 
{ 
    // Display Match player/freq stats in this format  (not aligned b/c of html but aligned in bot) 
    // --------------------------------------------------- 
    // Squad: squad_name_1            
K  D TK DMG DEALT TAKEN 
    // --------------------------------------------------- 
    // Player_1                      
0  0  0         0    
0     // Player_2                      
0  0  0         0    
0     // TOTAL:                     
0  0  0         0    
0 
    // --------------------------------------------------- 
    // Squad: squad_name_2            
K  D TK DMG DEALT TAKEN 

    // --------------------------------------------------- 
    // Player_3                      
0  0  0         0    
0     // Player_4                      
0  0  0         0    
0     // Player_5                      
0  0  0         0    
0     // TOTAL:                     
0  0  0         0    
0 
    // --------------------------------------------------- 

 
    for (freq=freqcount-1; freq>=0; freq--) 
    { 
        char str[255]; 

 
        sendFreqs("---------------------------------------------------"); 

 
        sprintf(str, "Squad: %-20s K  D TK DMG DEALT TAKEN", freqs[freq].freqname); 
        sendFreqs(str); 

 
        sendFreqs("---------------------------------------------------"); 

 
        for (pilot=freqs[freq].playercount-1; pilot >= 0; pilot--) 
        { 
            sprintf(str, "%-20s
%8d %2d %2d %9d %5d", freqs[freq].pilots[pilot].name, freqs[freq].pilots[pilot].kills, 
               
    freqs[freq].pilots[pilot].deaths, freqs[freq].pilots[pilot].teamkills,
freqs[freq].pilots[pilot].dmgdealt, 
               
    freqs[freq].pilots[pilot].dmgtaken); 
            sendFreqs(str); 
        } 

        
sprintf(str, "TOTAL:                    
%2d %2d %2d %9d %5d", freqs[freq].kills, freqs[freq].deaths, 
            freqs[freq].teamkills, freqs[freq].dmgdealt, freqs[freq].dmgtaken); 
        sendFreqs(str); 
    } 

 
    sendFreqs("---------------------------------------------------"); 
} 

</blockquote>

<a name="15k"></a> k) Example of checking if any pilots are
within a region

<blockquote>// see GetPilotName(name) function in other example, returns *player as TempPlayer from name 
// closeto() function from several previous examples 

 
bool botInfo::FreqAInBox() 
{ 
    // return true if teamA has a pilot in the box, otherwise false 
    for (int tempplayercount = freqs[0].playercount-1; tempplayercount >= 0; tempplayercount--) 
        if (GetPilotName(freqs[0].pilots[tempplayercount].name)) 
            if (closeto(TempPlayer,
coordX, coordY, 73) && (TempPlayer->ship != SHIP_Spectator)) 
                return true; 

 
    return false; 
} 

</blockquote>

<a name="15l"></a>
l) Example of functions to get a pilot's struct id info from a name or *player info 

<blockquote>// see struct examples for variable info 

 
// return struct freq/pilot id from *player info 
bool botInfo::GetPilot(Player *p) 

{ 

    // return freq, pilot of a player p 

    for (freq=freqcount-1; freq>=0; freq--) 

        if (p->team == freqs[freq].freqteam) 

            for (pilot = freqs[freq].playercount-1; pilot>=0; pilot--) 
               
if (strcmp(p->name,freqs[freq].pilots[pilot].name)==0) 

                    return true; 

 

    return false; 

} 

 
// return *player as TempPlayer info from p->name info bool botInfo::GetPilotName(char *name) 
{ 
    // get pilot from a name, return as TempPlayer 
    _listnode <Player> *parse = playerlist->head; 

 
    while (parse) 
    { 
        Player *p = parse->item; 

 
        // convert both to lowercase to compare 
        char pname[20];       
            
        strncpy(pname,p->name,20); 

 
        char nname[20];       
            
        strncpy(nname,name,20); 

 
        tolower(pname); 
        tolower(nname); 

 
        if (strcmp(pname,nname)==0) 
        { 
            TempPlayer = p; 
            return true; 
        } 

 
        parse = parse->next; 
    } 
    return false; 
} 
 
// note: better to implement these functions as passing values by reference instead of using global variables 
// just easier to not have to be declaring different int freq, int pilot all the time 

</blockquote>

<a name="15m"></a>
m) Example of creating a logfile name using date and squad names 

<blockquote>    // create log file name (squadA and squadB external char[20] variables) 
    char u[100]; 
    time_t t=time(NULL); 
    tm *tmp = localtime(&t); 
    strftime(u,99,"%y",tmp); 
    logname = "c:\Program Files\Continuum\logs\"; 
    logname += u; 
    logname += "y"; 
    strftime(u,99,"%m",tmp); 
    logname += u; 
    logname += "m"; 
    strftime(u,99,"%d",tmp); 
    logname += u; 
    logname += "d"; 
    logname += squadA; 
    logname += " vs "; 
    logname += squadB; 
    strftime(u,99,"%I",tmp); 
    logname += u; 
    logname += "h"; 
    strftime(u,99,"%M",tmp); 
    logname += u; 
    logname += "m"; 
    logname += ".txt"; 

 
// example name created:  03y01m27dBLACKDRaGON vs Integral05h08m.txt 
// format  year, month, day, squadA vs squadB, hour, minute 

</blockquote>


<a name="15n"></a>
n) Example of sending messages to playing freqs or public and logging depending on status 

<blockquote>// teamA, teamB, logname global variables 
void botInfo::sendFreqs(char *msg) 
{ 
    char *mmsg = "*arena"; 
    String s = msg; 
    
    if (teammsgs == false) 
    { 
        s.prepend("*arena ",7); 
        sendPublic(s); 
    } 
    else 
    { 
        sendTeamPrivate(8025,msg); 
        sendTeamPrivate(teamA,msg); 
        sendTeamPrivate(teamB,msg); 
    } 
    if (gameon == true) 
    { 
        ofstream outf(logname, ios::app); 
        outf << msg << endl; 
        outf.close(); 
    } 
} 

</blockquote>

<a name="15o"></a>
o) Example of reading in all player/freqs to struct data 

<blockquote>// see structures within structures example for freqs[] declaration 

 
// to get freqs in a game where there are several freqs 
void botInfo::GetFreqs() 
{ 
    // read pilots into freq struct data from ingame and on playing freqs 

 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
        Player *p = parse->item; 

 
        if (p->ship != SHIP_Spectator) 
            if (closeto(p, coordX, coordY, 73)) 
            { 
                // look for freq in struct 
                bool foundfreq=false; 

 
                freq=freqcount-1; 

 
                while ((freq>=0) && (foundfreq==false)) 
                { 
               
    if (p->team == freqs[freq].freqteam) 
                    { 
               
        foundfreq=true; 
               
        strncpy(freqs[freq].pilots[freqs[freq].playercount].name,
p->name, 20); 
               
        freqs[freq].playercount++;   
        
                    } 
                    freq--; 
                } 

 
                // didnt find freq in struct so add new freq 
                if (foundfreq == false) 
                { 
                    if (manualsquads == false) 
                    { 
               
        strncpy(freqs[freqcount].freqname,
p->squad, 20); 

 
               
        if (freqcount == 0) 
                        { 
               
            teamA = p->team; 
               
            strncpy(squadA,
p->squad, 20); 
                        } 
                        else 
                        { 
               
            teamB = p->team; 
               
            strncpy(squadB,
p->squad, 20); 
                        } 
                    } 
                    else 
                    { 
               
        if (p->team == teamA) 
               
            strncpy(freqs[freqcount].freqname,squadA,20); 

 
               
        else if (p->team == teamB) 
               
            strncpy(freqs[freqcount].freqname,squadB,20); 
                    } 
                    
               
    freqs[freqcount].freqteam = p->team; 

 
               
    strncpy(freqs[freqcount].pilots[0].name, p->name, 20); 
               
               

 
                    freqs[freqcount].playercount++; 
                    freqcount++; 
                } 
            } 
        parse = parse->next; 
    } 
} 

 
// to get freqs in a game where there are only two teams 
void botInfo::GetFreqs() 
{ 
    // read pilots into freq struct data from ingame and on playing freqs 
    _listnode <Player> *parse = playerlist->head; 
    
    while (parse) 
    { 
        Player *p = parse->item; 

 
        if ((p->ship != SHIP_Spectator)
&& ((p->team == teamA) || (p->team == teamB))) 
        { 
            // freq 100, team A 
            // set freq 
            freq = 0; 

 
            if (p->team == teamB) 
                freq = 1; 

 
            // number of pilots on freq counted so far, starts 0 
            pilot = freqs[freq].playercount; 

 
            // pilot name 
            strncpy(freqs[freq].pilots[pilot].name, p->name, 20); 
            // time stamp for playing time 
            freqs[freq].pilots[pilot].cplaying_time = GetTickCount(); 

 
            // slot name 
            if (freqs[freq].playercount < NUMBER_PILOTS) 
               
strncpy(freqs[freq].slotname[pilot], p->name, 20); 
        
            // increment freq player count 
            freqs[freq].playercount++; 

 
            // if freq not already have name, give it player squad name 
            if ((manualsquads == false) && (strlen(p->squad) > 0)) 
                strncpy(freqs[freq].freqname, p->squad, 20); 

 
            // set player ship 
            freqs[freq].pilots[pilot].ship = p->ship + 1; 
        } 
        parse = parse->next; 
    } 
} 

</blockquote>

<a name="15p"></a>
p) Example of finding MVP from struct data (2*kills - deaths formula) 

<blockquote>    int highest=-20; 
    int mvp=0; 

 
    for (pilot = freqs[mvpteam].playercount-1; pilot >=0; pilot--) 
    { 
        if (((freqs[mvpteam].pilots[pilot].kills
* 2) - freqs[mvpteam].pilots[pilot].deaths) > highest) 
        { 
            mvp = pilot; 
            highest = (freqs[mvpteam].pilots[pilot].kills
* 2) - freqs[mvpteam].pilots[pilot].deaths; 
        } 
    } 

</blockquote>

<a name="15q"></a>
q) Print time stamp of event 

<blockquote>#include "time.h" 

 
char u[100]; 
time_t t=time(NULL); 
tm *tmp = localtime(&t); 
strftime(u,99,"%c",tmp); 
sendPublic("Current date and time: " + (String) u); 

</blockquote>

<a name="15r"></a>
r) Simple way to track player bomb/bullet damage stats 

<blockquote>// spawn.cpp (see data section for how to setup set_tag) 
// see clientprot.h for weapon information 
 
case EVENT_WatchDamage: 
        { 
            if (PLAYING)  // if tracking stats 
            { 
               
if ((wi.type == PROJ_PBomb) && (p->name != k->name)) 
                { 
               
    set_tag(k, DMG_BOMB_DEALT, get_tag(k, DMG_BOMB_DEALT)
+ damage); 
               
    set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT)
+ damage); 
               
    set_tag(p, DMG_BOMB_TAKEN, get_tag(p, DMG_BOMB_TAKEN)
+ damage); 
               
    set_tag(p, DMG_TOTAL_TAKEN, get_tag(p, DMG_TOTAL_TAKEN)
+ damage); 
                } 
                else if (wi.type == PROJ_BBullet) 
                { 
               
    set_tag(k, DMG_BULLET_DEALT, get_tag(k, DMG_BULLET_DEALT)
+ damage); 
               
    set_tag(k, DMG_TOTAL_DEALT, get_tag(k, DMG_TOTAL_DEALT)
+ damage); 
               
    set_tag(p, DMG_BULLET_TAKEN, get_tag(k, DMG_BULLET_TAKEN)
+ damage); 
               
    set_tag(p, DMG_TOTAL_TAKEN, get_tag(k, DMG_TOTAL_TAKEN)
+ damage); 
                } 
            } 

</blockquote>

<a name="15s"></a>
s) Simple way to print those stats 

<blockquote>case OP_Moderator: 
{ 
            if (c->check("showstats")) 
            { 
                sendPublic("Showing stats:"); 

 
               
_listnode <Player> *parse = playerlist->head; 

 
                while (parse) 
                { 
                    Player *p = parse->item; 

 
               
    if (get_tag(p, DMG_TOTAL_DEALT) > 0) 
                    { 
                        char str[256]; 
               
        sprintf(str, "(%-20s Dmg Dealt: Total
%0004d, Bomb %0004d, Bullet %0004d  Dmg TAKEN: Total %0004d, Bomb %0004d,
Bullet %0004d)", 
               
        p->name, get_tag(p,DMG_TOTAL_DEALT),
get_tag(p,DMG_BOMB_DEALT), get_tag(p,DMG_BULLET_DEALT), 
               
        get_tag(p,DMG_TOTAL_TAKEN), get_tag(p,DMG_BOMB_TAKEN),
get_tag(p,DMG_BULLET_TAKEN)); 
               
        sendPublic(str); 
                    } 
                    parse = parse->next; 
                } 
            } 

</blockquote><a name="15t"></a>
t) Make bot spectate specific coordinates 
<blockquote>// make bot spectate the coord 512,600 
// possible use - capturing weapon packets in a specific region 
 
tell(makeFollowing(false)); 
tell(makeFlying(true)); 
me->move(512 * 16, 600 * 16); 
tell(makeSendPosition(true)); 
</blockquote>
</blockquote></blockquote>

Writing Modules In Python

2005-01-21T00:18:43Z

D1st0rt: rgn caching grammar

== Basic python module ==
I have tried to comment what is going on in the source. This module demonstrates callbacks, commands and using interfaces.
<pre>
# demo asss python module
# dec 28 2004 smong

# nearly always use this
from asss import *

# get some interfaces
# see chat.h for where I_CHAT comes from, see other .h files for more (fx:
# game.h)
chat = get_interface(I_CHAT)

# a callback
# this function is called when a player enters/leaves, see core.h for PA_???
# constants
def paction(p, action, arena):
# start indenting
if action == PA_ENTERARENA:
# see chat.h for the names of more functions like SendMessage
chat.SendMessage(p, "hello " + p.name)

# tell asss to call 'paction' when CB_PLAYERACTION is signalled
# see .h files for CB_??? names
cb1 = reg_callback(CB_PLAYERACTION, paction)

# a command
# see cmdman.h for what each parameter does
def c_moo(cmd, params, p, targ):
# help text (?help moo)
"""\
Module: <py> demo
Targets: none
a sample command.
"""
chat.SendMessage(p, "moo cows")

# tell asss to call 'c_moo' when a player types ?moo
# note: add cmd_moo to conf/groupdef.dir/default so players have permission to
# use this command.
cmd1 = add_command("moo", c_moo)

# setting chat (or other interfaces), cb* or cmd* to None is equivalent to
# unregistering that item.
</pre>
Save this in bin/demo.py. Then ingame make sure pymod is loaded by using ?lsmod and ?insmod. Then add this module with the following command: ?insmod <py> demo. Re-entering the arena and typing ?moo should do some stuff.

== Code snippets ==
The bread and butter of most custom modules.
=== Callbacks ===
<pre>
from asss import *

chat = get_interface(I_CHAT)

def goal(arena, p, bid, x, y):
chat.SendArenaMessage(arena, "goal.")

cb1 = reg_callback(CB_GOAL, goal)
</pre>

=== Commands ===
Useful for controlling events, fx: ?elim start. In this case the command is ?t1.
<pre>
from asss import *

chat = get_interface(I_CHAT)

def c_mycmd(cmd, params, p, targ):
"""\
some help text
"""
chat.SendMessage(p, "moo.")

cmd1 = add_command("t1", c_mycmd)
#where the "t1" is located would be the name of the command, ex: ?t1
</pre>

=== Per-player/arena data ===
Use this to store game state, player score, etc.
<pre>
def shipchange(p, newship, newfreq):
# prefix mymod_ an abbreviation of your module name to the variable
# so that it doesn't clash with other modules. per arena data works
# in exactly the same way.
p.mymod_lastship = p.ship

cb1 = reg_callback(CB_SHIPCHANGE, shipchange)
</pre>

=== Attach/Detach ===
Attaching and detaching is similar to load/unload in a C module except it is arena specific. So you can use it to initialise per-arena data.
<pre>
def mm_attach(arena):
# do stuff with arena
def mm_detach(arena):
# undo stuff
</pre>

=== Looping over all players ===
This example counts the number of players in an arena.
<pre>
def count_players(arena):
# a list must be used as all other variables are immutable to
# nested functions.
players = [0]
def cb_count(p):
if p.arena == arena:
players[0] = players[0] + 1
for_each_player(cb_count)
return players[0]
</pre>

=== Timers ===
Good for checking if a game is over yet. '''A reference to the timer is returned and must be retained''' (you can use per-arena data to store it). Losing the reference will cancel the timer.

''initial'' is the time in 1/100th's of a second before the nested function timer() will be called, you can cancel the timer before it is called. ''interval'' is the time gap, again in 1/100th's of a second between all future calls of timer(). So make_hello_timer(100, 200, arena) will make it send the arena message "hello" every 2 seconds starting from 1 second after make_hello_timer() was called.

The parameter ''arena'' is needed in this case because SendArenaMessage() requires an arena parameter.
<pre>
def make_hello_timer(initial, interval, arena):
def timer():
# announce
chat.SendArenaMessage(arena, "hello")
# non-repeating timer. return 1 for it to be called after the next interval
return 0
return set_timer(timer, initial, interval)

def somefunc(arena):
# create a hello timer that will execute after 1 second, and then every
# 2 seconds until cancelled. timers can cancel themselves, see above.
myref = make_hello_timer(100, 200, arena)

# cancel the timer by losing the reference to it
myref = None
</pre>

=== Regions ===
This is untested but it should go something like this:
<pre>
mapdata = get_interface(I_MAPDATA)

# regionname is a string, x and y are map tile coords.
def region_contains(arena, regionname, x, y):
success = 0

rgn = mapdata.FindRegionByName(arena, regionname)

if rgn != None and mapdata.Contains(rgn, x, y):
success = 1

return success
</pre>
It is a good idea to cache ''rgn'' within [[#Per-player.2Farena_data|per-arena data]] so you don't add unecessary load to the server looking it up everytime.

== Trouble shooting ==
Look at the asss console for execution errors (at the time of writing not all errors are relayed to logged in staff), and if that doesn't help, add some chat.SendArenaMessage(ALLARENAS, "i'm at line ...") type messages to locate the buggy piece of code.

[[Category: Module]]
[[Category: Tutorial]]

Category:Settings

2005-01-14T21:16:27Z

D1st0rt: suggestion

(D1s: Just a thought, but wouldn't it be better to be 1 page with a table of contents?... I'd do it but I don't know how)
(ed: To be an online template.sss)

[[Misc]]
*[[Bomb]]
*[[Mine]]
*[[Shrapnel]]
*[[Burst]]
*[[Toggle]]
*[[Prize]]
*[[Radar]]
*[[Team]]
*[[Kill]]
*[[Repel]]
*[[Message]]
*[[Wormhole]]
*[[Latency]]
*[[Brick]]
*[[Rocket]]
*[[Door]]
*[[Territory]]
*[[Periodic]]
*[[Security]]
*[[Packetloss]]
*[[Routing]]
*[[King]]
*[[Bullet]]

[[PrizeWeight]]

[[Cost]]

[[Ship]]

[[Flag]]

[[Soccer]]

arena.conf
*[[General]]
*[[Module-settings|Modules]]

[[Category: Tutorial]]

Hyperspace

2005-01-14T02:25:19Z

D1st0rt: AreaBot history

SSCX-A Hyperspace was one of the first zones to adopt [[ASSS]].

== Gameplay ==

== Staff ==

<table border=0 frame=void rules=cols width=50%>
<tr>
<td align=center colspan=3><h3>Sysops and Smods</h3></td>
</tr>
<tr>
<td align=center>[[User:Dr Brain|Dr Brain]]</td>
<td align=center>Picano</td>
<td align=center>Nerusai</td>
</tr>
</table>

<table border=0 frame=void rules=cols width=50%>
<tr>
<td align=center colspan=4><h3>Moderators</h3></td>
</tr>
<tr>
<td align=center>D1st0rt</td>
<td align=center>Coenny</td>
<td align=center>Quigybobo</td>
<td align=center>Bomook</td>
</tr>
<tr>
<td align=center>Wargh</td>
<td align=center>FunkmastaD</td>
<td align=center>nikegurl</td>
<td align=center>Lanvalk</td>
</tr>
</table>

== History ==

=== Event Horizon ===

Hyperspace started life as a LAN zone played by a small group of friends, Dr Brain among them. They eventually decided to put it online to try and get more players in it. Having something of a scientific bent, they decided to name it ''Event Horizon'' after the point of no return surrounding black holes. The zone, once online never took off. It was briefly hosted on Can-Link before the hosting service imploded. After considering that the zone had only reached a maximum population of 4 players, the zone was abandoned and the group persued more rewarding games such as Infantry and Starcraft.

=== Dog Fight ===

Months later, Dr Brain revived the zone under the name ''Dog Fight'' with a new map. Again, nothing happened with the zone and it was closed.

=== Jeff's Zone ===

In order to experiment with [[Subgame2]] Dr Brain again hosted Dog Fight under the new name ''Jeff's Stupid Zone''. After some days of fiddling, Dr Brain finally figured out how to make Hypertunnels work. He remade the map and added some Hypertunnels around the very edge of the map. The zone's population doubled to a whole 6 players at peak times. Encouraged by this incredible population boost, more hypertunnels were added and the zone was renamed to ''Jeff's Zone''.

=== Hosting, at last ===

Ever since the collapse of Can-Link, the zone had been hosted by Dr Brain on his cable connection. This lead to occasional downtime because of computer crashes and also to more lag than was preferable. SSDZ offered its services and the zone was moved.

=== Hyperspace ===

Dr Brain felt, now that the zone was picking up, that the name ''Jeff's Zone'' was no longer good enough. So, he started asking the player population about new name ideas. Someone suggested the name ''Hyperspeed'' and everyone agreed that it was a great name. Somehow, Dr Brain forgot the exact details of the name and changed the name to ''Hyperspace''. Only later did he realize that everyone had agreed to ''Hyperspeed'', but by then, it was too late to change.

=== Project 0 ===

This zone was created mainly for graphics testing but later on became "known" for a small heavily bot maintained arena called Warp2 (warpto joke). Many colorful graphics and anime girls (specifically catgirls) were featured here.

Average population was around eight and at max 14, not counting 6 bots (only 1 full time).

=== SSXH ===

The intermittent failures of SSDZ lead Dr Brain and picano2.0 to search for new hosting. SSXH under Delta_5 agreed to host the zone and a long period of properity for Hyperspace started.

=== SSND/SSDX ===

Eventually, SSXH decided to close down. A new host was needed and the SSDX network accepted Hyperspace. After a merger between SSDX and SSN, and several moves between servers on the SSN network, Hyperspace eventually settled down. Unfortuantly, the peace was not to last. Within weeks of quieting down, SSN closed down for no obvious reason.

=== SSI ===

Due to the collapse of SSN, Hyperspace was again hostless and had to be hosted by Dr Brain's less-than-perfect connection. Eventually, hosting was secured from SSI (run by 1stStrike and Argyle). Again, the zone flourished.

=== TWCore & AreaBot ===

As part of the SSI hosting package, Hyperspace developers were given access to the [[TWCore]] bot system (at the time, it was not public access). Everything was great for a while with small populations, but changes were needed to support the growing population. Initially, all kills gave 50 'HS Bucks'. This was changed to an earnings formula by [[User:D1st0rt|D1st0rt]] which was roughly 1+(killed bty / killer bty) * 50. Eventually, as winnings increased, all accounts were reset and prices were raised significantly. As the population in a single arena approached 30, the strain on the AreaBot became too great and it would cease to function. The ?help command was flooded with "FIX THE BOT NOW N00B STAFFS!!!" while available mods scrambled to kill the existing bot and spawn another from the hub. Over time, it got so bad that the hub itself died and had to be manually restarted by 1stStrike. This is considered the "Dark Age" of Hyperspace for the moderating team. In response to the situation, Dr Brain began working on a new system for the then unheard of and highly experimental [[ASSS]] server. The zone took a leave of absence for a few months before re-emerging as SSCX-A.

-add more-

=== Getting SSC ===

=== SSCX-A ===

[[Category: Zones]]

Talk:Hosts

2005-01-14T02:11:53Z

D1st0rt: guess it doesn't add name automatically

[[User:CypherJF|CypherJF]]: Actually I don't think SSN is run by L Chance anymore. I'm not sure the history of it but the latest back I can remember was Altec . running it with Sideburn? Spring/Summer of 2004, Altec . and L Chance brought back SSN using Lord Maucaub's biller system. They shut it back down after HALO switched back to SSZ; and now I believe Dark Mistress / TheBest999 / Cospar / MS-DOS; someone is running it.

[[User:Smong|Smong]]: I think NTC has it now. They keep changing tags which is annoying. For the record I remember them with SSDM and TNT too if you want to stick that in a 'most annoying network decisions ever' page.

[[User:CypherJF|CypherJF]]: Yeah NTC is the Dark Mistress / TheBest999 / Cospar / MS-DOS network.

[[User:Smong|Smong]]:Someone add NTC and SSDT at least. Also I think this page should be called Networks, but that is more jargon I guess and could easily be confused.

[[User:D1st0rt|D1st0rt]]:Whoa 17th is near me? Trench still has a lower ping

Talk:Hosts

2005-01-14T02:10:43Z

D1st0rt:

CCC

2005-01-14T02:03:35Z

D1st0rt: spelling

CCC is a chat client using the [[ChatNet Protocol|TCP chat protocol]]. It's written in Python by [[grelminar]]. It is available in the [[ASSS]] distribution, or from http://sscx.net/asss/ccc.

Features:

* runs in a console windows, so it's easy to use over ssh
* auto-reconnecting after disconnection
* complete logging of everything to a file
* double-colon support
* separate windows for different chat channels, mod chat, and private messages
* multiple profile support
* auto-enter commands

[[Category: ChatNet Clients]]

Writing Modules In C

2005-01-10T22:03:23Z

D1st0rt:

The easiest way to write a module in C is to work off a template, as certain parts of all modules are identical. Here is a template that does nothing more than connect with the server:

<pre>/*
Template Module
*/

#include "asss.h"
// Interfaces
local Imodman *mm;

// The entry point:
EXPORT int MM_testModule(int action, Imodman *mm_, Arena *arena)
{
if (action == MM_LOAD)
{
mm = mm_;
return MM_OK;
}
else if (action == MM_UNLOAD)
{
return MM_OK;
}
else if (action == MM_ATTACH)
{
return MM_OK;
}
else if (action == MM_DETACH)
{
return MM_OK;
}
return MM_FAIL;
}
</pre>

Creating New Subarenas

2005-01-10T21:58:15Z

D1st0rt:

To create a new arena type '''?makearena (arena name)'''. Settings changes made in this arena will now only apply to this arena.

To change the map, change the location of the file in the [General] Section

Writing Modules In C

2005-01-10T21:53:23Z

D1st0rt: formatted code

The easiest way to write a module in C is to work off a template, as certain parts of all modules are identical. Here is a template that does nothing more than connect with the server:

(TODO: How do I format code?)
<pre>/*
Template Module
*/

#include "asss.h"
// Interfaces
local Imodman *mm;

// The entry point:
EXPORT int MM_testModule(int action, Imodman *mm_, Arena *arena)
{
if (action == MM_LOAD)
{
mm = mm_;
return MM_OK;
}
else if (action == MM_UNLOAD)
{
return MM_OK;
}
else if (action == MM_ATTACH)
{
return MM_OK;
}
else if (action == MM_DETACH)
{
return MM_OK;
}
return MM_FAIL;
}
</pre>

TWCore

2005-01-10T21:45:38Z

D1st0rt:

TWCore is an open source bot core written in Java maintained by qan. Widely used in Trench Wars(TW), it can be downloaded from [http://twcore.twzone.net/core/ here]. It's rivals include [[MERVCore]] and [[Powerbot]].