Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
136 lines (130 sloc) 4.06 KB

Grapevine support for CircleMUD/tbaMUD


Modify these files to add Grapevine support. Add grapevine.h to the includes section at the top of each .c file.

  • db.c: At the end of the free_char function:
  if (ch->gvChannel)
    delete ch->gvChannel;

At the end of the init_char function:

  ch->gvChannel = NULL;
  • interpreter.c: In your command_info cmd_info[] struct:
  { "gvplayer" , "gvp"   , POS_DEAD    , do_gvplayer , 0, 0, 0 },
  { "gvgame"   , "gvg"   , POS_DEAD    , do_gvgame   , 0, 0, 0 },
  { "gvtell"   , "gvt"   , POS_DEAD    , do_gvtell   , 0, 0, 0 },
  { "gvchannel", "gvc"   , POS_DEAD    , do_gvchannel, 0, 0, 0 },

Adjust number of fields to suit your code as needed.

  • comm.c: After boot_db() in the init_game function:
  // start Grapevine connection
     std::string url = "wss://";
     std::string client_id = "<your Grapevine client id>";
     std::string client_secret = "<your Grapevline client secret>";

     GvChat = new ix::GvChat(url, client_id, client_secret, "1.0.0", "<your mud name>");

In copyover_recovery() after "Warm Boot initiated" or "Copyover recovery initiated":

  // connect to Grapevine

In game_loop() right at the top of the main loop:

// Process log queue
if (GvChat->getLogMessagesCount() > 0)

In game_loop() right before "Process descriptors with input pending":

// Process Grapevine messages
      if (GvChat->getReceivedMessagesCount() > 0)
  • handler.c: At the start of the extract_char function:
  if (!IS_NPC(ch))
  • interpreter.c: At the end of enter_player_game before the return:
  • structs.h: At the top in the includes section:
#include <string>
#include <crossguid/guid.hpp>

At the end of struct char_data:

   std::string *gvChannel;   // current channel for this player
   bool gvGameAll;          // show all games or just one?
   bool gvFirstGame;        // is this the first game if gvGameAll == true?
  • act.h (or wherever you want to put your ACMDs, we use acmd.h)
//grapevine commands
ACMD(do_gvplayer);  ACMD(do_gvgame);      ACMD(do_gvtell);

Makefile changes

You'll have to add the following libraries to compile:

-lixwebsocket -lcrypto -lssl -lpthread -luuid -lcrossguid

Changes needed for stock Circle/tba code bases:

World of Pain uses C++ vector classes for things like descriptor_list and character_list, so if you don't, you'll need to replace lines in grapevine.cpp such as the following:

  for (auto &i : descriptor_list) 


  for (auto &i : character_list)

with stock Circle/tba conventions like:

  for (i = descriptor_list; i; i = i->next)


  for (i = character_list; i; i = i->next)

Player Command Help


Shows the players online with Grapevine in a game or all games.

Usage: gvplayer <game>
<game> is the optional short name for a game in Grapevine. Specify no game to see all players in all games.


Shows all games currently online in Grapevine or gets detailed information on a specific game.

Usage: gvgame <game>
<game> is the optional short name for a game in Grapevine. Specify no game to see all games online.


Send a private tell to a player in another game on Grapevine.

Usage: gvtell <player@game> <message>


Send a message to everyone on a particular channel on all games on Grapevine, or switch channels.

Usage: gvchannel <message>
OR gvchannel <channel>
Currently supported channels are gossip and testing. The default channel is gossip.
You can’t perform that action at this time.