server scripts (download)

[neorej16]

I'm currently using the attached scripts for my RoRnet_2.37 server. They're now free to use without attribution. I hope that this encourages more people to start experimenting with scripts

How to set up
Warning: this is not a replacement text for the server setup tutorial. Please read it first: Server_Setup_Tutorial

1. Download the attachment and extract the zip archive in a new folder somewhere. In the following steps, I'll call this new folder your 'working directory'.
2. Download the official binaries from here: http://sourceforge.net/projects/rors...9.zip/download and extract them to the 'bin' folder of your working directory.
3. [optional] Edit the settings in the 'settings' folder of your working directory.
4. Double click 'server_LAN.bat' for a LAN server or 'server_INET.bat' for an Internet server.

How to configure the scripts

1. Open 'resources/scripts/exampleScript.as' with a text editor.
2. Add '//' in front of the lines that you want to disable.

Script files included

• chatManager.as: Manages the chat (command handling, flood filter, word filter etc) by means of a chatManager class and several plugins for it.
• gameScriptWrapper.as: Provides a wrapper for the server.cmd function and has a gameScriptManager class that will handle incoming game commands and clientside events (0.39 only!) and this file also has a terrainFileLoader that allows you to modify the terrain. An example of this is included for nhelens.terrn (terrain file: resources/scripts/storage/nhelens_terrn.asdata, note the special syntax (but the default terrn syntax will work as well, the syntax that I used is just more error proof (in my opinion))). In theory, you could use the terrainFileLoader to change a race track every 10 minutes (or even change the whole terrain if you're using mesh terrains), but it might give collision problems.
• localstorage.as: A serverside implementation of the clientside localstorage class.
• profanityFilter.as: A file containing profanity filtering functions and the wordlist for them.
• utils.as: This file has various functions and constants that will be used by various other files.
• terrainEditor.as: This file allows you to edit terrains while playing online (so all changes are visible for all players), but I've mainly included it as an extra example, as it messes up the collision system. (need to fix that in the client)

Data files included

• nhelens_terrn.asdata: My terrain edits for nhelens.
• chatPlugin_gotoCommand.asdata: Some positions for the !goto command on nhelens.

Warnings

• Use of these script files or any other files attached to this post is at your own risk. Using script files might change the system resource usage of the server.

Feel free to ask help in this thread if problems arise.

[EBs Servers]

says my RORSERVER.exe is missing?

[Creak]

You haven't downloaded the official binaries, have you?

[neorej16]

says my RORSERVER.exe is missing?

Hmm, strange.
It works here if the rorserver.exe file is in the correct location (bin/rorserver.exe).
Anyway, if you're sure that you have downloaded the files from sourceforge and that the files in the correct position, then you can download the attached alternative .bat files here, which don't check for the existence of rorserver.exe before trying to start it.

[EBs Servers]

Hmm, strange.
It works here if the rorserver.exe file is in the correct location (bin/rorserver.exe).
Anyway, if you're sure that you have downloaded the files from sourceforge and that the files in the correct position, then you can download the attached alternative .bat files here, which don't check for the existence of rorserver.exe before trying to start it.

Thanks everything works correctly now

[neorej16]

I received a private message today, in which someone asked for some more information about scripting. As there's actually not a lot documentation about how to write a script from scratch, I've decided to put an extra example here. (and the private messaging system doesn't allow messages with more than 5000 characters, which is the main reason why I put it here ).

The language which you use for your scripts is AngelScript. The syntax and default functions of the class are explained here (in combination with the wiki page).

The scripting implementation of the Rigs of Rods server is event-based, which means that you'll be able to execute code when certain events happen. The current available events on the server are: the server starts (main), a new player joins the server (playerAdded), a player leaves the server (playerDeleted), a player says something in the chat (playerChat), the client of a player sends a script message (gameCmd) and a sixth event that just happens every 200 milliseconds (frameStep).

At each of those events, you can execute code. Here's a very simple example that just shows a chat message to all players on the playerAdded event:

// The main event, we don't need this at the moment, but the script won't work without it being defined
void main() {}

// The playerAdded event
void playerAdded(int uid)
{
    server.say("A new player joined the server.", TO_ALL, FROM_HOST);
} 

You can execute that script by simply putting it in a text file with extension .as, and specify the file as scriptfile in the server configuration.

The next step in our simple script would be to add the username to the message. We can do this using the string server.getUserName(int uid) function:

void main() {}
void playerAdded(int uid)
{
    // Create a new variable holding the username
    string name = server.getUserName(uid);
    
    // And add the name to the message
    server.say("Player " + name + " joined the server.", TO_ALL, FROM_HOST);
} 

That's still a very simple example. More complicated would be to hold statistics of usernames. We can do this by using a dictionary object as global variable. A dictionary object can store information and retrieve it again, based on a name (so, like a dictionary). So we're just going to store a simple number ('int') for every username that joins the server, and every time that we see the username again, we increase the counter by 1. (so the first time that the user joins, the counter will be 1, the second time that the user joins, the counter will be 2, etc).

// Create our dictionary as global variable
dictionary userJoinStats();

// The main function, we don't need this at the moment, but the script won't work without it being defined
void main() {}

// This function will get called when a player joins the game
void playerAdded(int uid)
{
    // Create a new variable holding the username
    string name = server.getUserName(uid);
    
    // Get the amount of times that we've seen this player before
    int timesSeen;
    if( not userJoinStats.get(name, timesSeen) )
    {
        timesSeen = 0;
    }
    
    // As the player just joined, we have to increase our timesSeen counter by 1
    timesSeen += 1;
    
    // And we store the updated value of our counter
    userJoinStats.set(name, timesSeen);
    
    // And instead of showing a global message, we'll now show a private message to this user.
    // The message will be different, depending on whether this is the first time that this user joined the server.
    if(timesSeen==1)
        server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
    else
        server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
} 

That's already quite a useful script Just as example, I'll also add a chat command now, that will allow you to see how many times a certain player joined the server:

// Create our dictionary as global variable
dictionary userStats();

// The main function, we don't need this at the moment, but the script won't work without it being defined
void main() {}

// This function will get called when a player joins the game
void playerAdded(int uid)
{
    // Create a new variable holding the username
    string name = server.getUserName(uid);
    
    // Get the amount of times that we've seen this player before
    int timesSeen;
    if( not userStats.get(name, timesSeen) )
    {
        timesSeen = 0;
    }
    
    // As the player just joined, we have to increase our timesSeen counter by 1
    timesSeen += 1;
    
    // And we store the updated value of our counter
    userStats.set(name, timesSeen);
    
    // And instead of showing a global message, we'll now show a private message to this user.
    // The message will be different, depending on whether this is the first time that this user joined the server.
    if(timesSeen==1)
        server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
    else
        server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
}

// The playerChat event that will happen at every chat message
int playerChat(int uid, string msg)
{
    // Split the message on spaces
    array<string>@ arguments = msg.split(" ");
    
    // We need at least 1 argument in our message
    if(arguments.length()>=1)
    {
        // We only need to do something if the first word in the message is the command (first word = argument 0)
        if( arguments[0] == "!seen" )
        {
            // For this command, we'll need at least 2 arguments in the message (the command itself, and a uid)
            if(arguments.length()<2)
            {
                server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                server.say("Example: !seen 152", uid, FROM_SERVER);
            }
            else
            {
                // The second word should be the unique identifier of the user of whom we want to get the statistics of
                int buid = parseInt(arguments[1]);
                
                // Get the username that matches the unique identifier
                string name = server.getUserName(buid);
                
                // The getUserName function returns something empty when the requested uid is not online
                if(name=="")
                {
                    server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                    server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                    server.say("Example: !seen 152", uid, FROM_SERVER);
                }
                else
                {
                    // Get the amount of times that we've seen the player before
                    int timesSeen;
                    if( not userStats.get(name, timesSeen) )
                    {
                        timesSeen = 0;
                    }
                    
                    // And show it as output to the user that requested it
                    server.say("User " + name + " (" + buid + ") has been seen " + timesSeen + " times on this server.", uid, FROM_SERVER);
                }
            }
        }
    }
    
    // You can change broadcasting levels using this function, but here, we'll change nothing by returning BROADCAST_AUTO
    return BROADCAST_AUTO;
} 

So, we now have user statistics that will allow you to find out which usernames are commonly used on your server. Using the localStorage.as file from the first post in this thread, we'll be able to keep the statistics stored across sessions. The localStorage object is very similar to the dictionary object, but the localStorage object can also load and save the data to a file.

// Include the localStorage file
#include "localStorage.as"

// Create our dictionary as global variable
localStorage userStats("userJoinStatistics.asdata");

// The main function, we don't need this at the moment, but the script won't work without it being defined
void main() {}

// This function will get called when a player joins the game
void playerAdded(int uid)
{
    // Create a new variable holding the username
    string name = server.getUserName(uid);
    
    // Get the amount of times that we've seen this player before
    int timesSeen;
    if( not userStats.get(name, timesSeen) )
    {
        timesSeen = 0;
    }
    
    // As the player just joined, we have to increase our timesSeen counter by 1
    timesSeen += 1;
    
    // And we store the updated value of our counter
    userStats.set(name, timesSeen);
    
    // Save the statistics
    userStats.save();
    
    // And instead of showing a global message, we'll now show a private message to this user.
    // The message will be different, depending on whether this is the first time that this user joined the server.
    if(timesSeen==1)
        server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
    else
        server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
}

// The playerChat event that will happen at every chat message
int playerChat(int uid, string msg)
{
    // Split the message on spaces
    array<string>@ arguments = msg.split(" ");
    
    // We need at least 1 argument in our message
    if(arguments.length()>=1)
    {
        // We only need to do something if the first word in the message is the command (first word = argument 0)
        if( arguments[0] == "!seen" )
        {
            // For this command, we'll need at least 2 arguments in the message (the command itself, and a uid)
            if(arguments.length()<2)
            {
                server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                server.say("Example: !seen 152", uid, FROM_SERVER);
            }
            else
            {
                // The second word should be the unique identifier of the user of whom we want to get the statistics of
                int buid = parseInt(arguments[1]);
                
                // Get the username that matches the unique identifier
                string name = server.getUserName(buid);
                
                // The getUserName function returns something empty when the requested uid is not online
                if(name=="")
                {
                    server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                    server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                    server.say("Example: !seen 152", uid, FROM_SERVER);
                }
                else
                {
                    // Get the amount of times that we've seen the player before
                    int timesSeen;
                    if( not userStats.get(name, timesSeen) )
                    {
                        timesSeen = 0;
                    }
                    
                    // And show it as output to the user that requested it
                    server.say("User " + name + " (" + buid + ") has been seen " + timesSeen + " times on this server.", uid, FROM_SERVER);
                }
            }
        }
    }
    
    // You can change broadcasting levels using this function, but here, we'll change nothing by returning BROADCAST_AUTO
    return BROADCAST_AUTO;
} 

So, now you have a system that will keep track of usernames. Possible further additions that you can make:

• Allow the !seen command to search on names instead of unique identifiers.
• Add the relative time when a user was last seen.
• Keep track of how much time a user spends on the server.
• Allow the script to be used by multiple running servers (use the servername or server port to create seperate filenames for each server)
• ...

Just for the record (to keep this on topic ), here's the script rewritten as chat plugin for the script wrappers earlier in this thread:

• chatPlugin_joinStats.as
  

  #include "utils.as"
  #include "chatManager.as"
  
  void chatPlugin_joinStats_seenCommand(chatMessage@ cmd)
  {
      chatPlugin_joinStats@ obj;
      cmd.argument.retrieve(@obj);
      obj.callback_seenCommand(cmd);
  }
  
  class chatPlugin_joinStats
  {
      // Create our dictionary as global variable
      localStorage@ userStats;
      
      // A reference to the chat manager
      chatManager@ chtmngr;
      
      // internal flag
      bool registered;
      
      
      chatPlugin_joinStats(chatManager@ _chtmngr)
      {
          @chtmngr = @_chtmngr;
  
          // Register the callbacks
          chtmngr.addCommand("seen", @chatPlugin_joinStats_seenCommand, @any(@this), true, AUTH_ALL);
          server.setCallback("playerAdded", "playerAdded", @this);
          
          // Load the statistics file
          @userStats = @localStorage("userJoinStatistics.asdata");
          
          registered = true;
      }
  
      ~chatPlugin_joinStats()
      {
          destroy();
      }
  
      void destroy()
      {
          if(registered)
          {
              chtmngr.removeCommand("seen");
              server.deleteCallback("playerAdded", "playerAdded", @this);
              registered = false;
          }
      }
      
      // This function will get called when a player joins the game
      void playerAdded(int uid)
      {
          // Create a new variable holding the username
          string name = server.getUserName(uid);
          
          // Get the amount of times that we've seen this player before
          int timesSeen;
          if( not userStats.get(name, timesSeen) )
          {
              timesSeen = 0;
          }
          
          // As the player just joined, we have to increase our timesSeen counter by 1
          timesSeen += 1;
          
          // And we store the updated value of our counter
          userStats.set(name, timesSeen);
      
          // Save the statistics
          userStats.save();
          
          // And instead of showing a global message, we'll now show a private message to this user.
          // The message will be different, depending on whether this is the first time that this user joined the server.
          if(timesSeen==1)
              server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
          else
              server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
      }
  
      void callback_seenCommand(chatMessage@ cmsg)
      {
          // We need at least 1 argument and that argument needs to be a number
          if(cmsg.emsgLen<2 || !isNumber(cmsg.emsg[1]))
          {
              cmsg.privateGameCommand.message("!seen shows join statistics of a certain user.", "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Usage:   !seen <uid>",                           "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Example: !seen 152",                             "information.png", 30000.0f, true);
              return;
          }
          
          // The second word should be the unique identifier of the user of whom we want to get the statistics of
          int buid = parseInt(cmsg.emsg[1]);
                      
          // Get the username that matches the unique identifier
          string name = server.getUserName(buid);
                      
          // The getUserName function returns something empty when the requested uid is not online
          if(name=="")
          {
              cmsg.privateGameCommand.message("!seen shows join statistics of a certain user.", "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Usage:   !seen <uid>",                           "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Example: !seen 152",                             "information.png", 30000.0f, true);
              return;
          }
          
          // Get the amount of times that we've seen the player before
          int timesSeen;
          if(!userStats.get(name, timesSeen))
              timesSeen = 0;
          
          // And show it as output to the user that requested it
          cmsg.privateGameCommand.message("User " + name + " (" + buid + ") has been seen " + timesSeen + " times on this server.", "chart_bar.png", 30000.0f, true);
      }
  } 

• your script file
  

  #include "chatManager.as"
  #include "chatPlugin_joinStats.as"
  
  chatManager chatSystem();
  chatPlugin_joinStats joinStats(@chatSystem);
  void main() {} 

(also, I've just updated the attachment of the first post, as there was a small bug in the localStorage.as file (line 262)).

[EBs Servers]

I received a private message today, in which someone asked for some more information about scripting. As there's actually not a lot documentation about how to write a script from scratch, I've decided to put an extra example here. (and the private messaging system doesn't allow messages with more than 5000 characters, which is the main reason why I put it here ).

The language which you use for your scripts is AngelScript. The syntax and default functions of the class are explained here (in combination with the wiki page).

The scripting implementation of the Rigs of Rods server is event-based, which means that you'll be able to execute code when certain events happen. The current available events on the server are: the server starts (main), a new player joins the server (playerAdded), a player leaves the server (playerDeleted), a player says something in the chat (playerChat), the client of a player sends a script message (gameCmd) and a sixth event that just happens every 200 milliseconds (frameStep).

At each of those events, you can execute code. Here's a very simple example that just shows a chat message to all players on the playerAdded event:
<< php >>
You can execute that script by simply putting it in a text file with extension .as, and specify the file as scriptfile in the server configuration.

The next step in our simple script would be to add the username to the message. We can do this using the string server.getUserName(int uid) function:
<< php >>

That's still a very simple example. More complicated would be to hold statistics of usernames. We can do this by using a dictionary object as global variable. A dictionary object can store information and retrieve it again, based on a name (so, like a dictionary). So we're just going to store a simple number ('int') for every username that joins the server, and every time that we see the username again, we increase the counter by 1. (so the first time that the user joins, the counter will be 1, the second time that the user joins, the counter will be 2, etc).
<< php >>

That's already quite a useful script Just as example, I'll also add a chat command now, that will allow you to see how many times a certain player joined the server:

// Create our dictionary as global variable
dictionary userStats();

// The main function, we don't need this at the moment, but the script won't work without it being defined
void main() {}

// This function will get called when a player joins the game
void playerAdded(int uid)
{
    // Create a new variable holding the username
    string name = server.getUserName(uid);
    
    // Get the amount of times that we've seen this player before
    int timesSeen;
    if( not userStats.get(name, timesSeen) )
    {
        timesSeen = 0;
    }
    
    // As the player just joined, we have to increase our timesSeen counter by 1
    timesSeen += 1;
    
    // And we store the updated value of our counter
    userStats.set(name, timesSeen);
    
    // And instead of showing a global message, we'll now show a private message to this user.
    // The message will be different, depending on whether this is the first time that this user joined the server.
    if(timesSeen==1)
        server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
    else
        server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
}

// The playerChat event that will happen at every chat message
int playerChat(int uid, string msg)
{
    // Split the message on spaces
    array<string>@ arguments = msg.split(" ");
    
    // We need at least 1 argument in our message
    if(arguments.length()>=1)
    {
        // We only need to do something if the first word in the message is the command (first word = argument 0)
        if( arguments[0] == "!seen" )
        {
            // For this command, we'll need at least 2 arguments in the message (the command itself, and a uid)
            if(arguments.length()<2)
            {
                server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                server.say("Example: !seen 152", uid, FROM_SERVER);
            }
            else
            {
                // The second word should be the unique identifier of the user of whom we want to get the statistics of
                int buid = parseInt(arguments[1]);
                
                // Get the username that matches the unique identifier
                string name = server.getUserName(buid);
                
                // The getUserName function returns something empty when the requested uid is not online
                if(name=="")
                {
                    server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                    server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                    server.say("Example: !seen 152", uid, FROM_SERVER);
                }
                else
                {
                    // Get the amount of times that we've seen the player before
                    int timesSeen;
                    if( not userStats.get(name, timesSeen) )
                    {
                        timesSeen = 0;
                    }
                    
                    // And show it as output to the user that requested it
                    server.say("User " + name + " (" + buid + ") has been seen " + timesSeen + " times on this server.", uid, FROM_SERVER);
                }
            }
        }
    }
    
    // You can change broadcasting levels using this function, but here, we'll change nothing by returning BROADCAST_AUTO
    return BROADCAST_AUTO;
} 

So, we now have user statistics that will allow you to find out which usernames are commonly used on your server. Using the localStorage.as file from the first post in this thread, we'll be able to keep the statistics stored across sessions. The localStorage object is very similar to the dictionary object, but the localStorage object can also load and save the data to a file.

// Include the localStorage file
#include "localStorage.as"

// Create our dictionary as global variable
localStorage userStats("userJoinStatistics.asdata");

// The main function, we don't need this at the moment, but the script won't work without it being defined
void main() {}

// This function will get called when a player joins the game
void playerAdded(int uid)
{
    // Create a new variable holding the username
    string name = server.getUserName(uid);
    
    // Get the amount of times that we've seen this player before
    int timesSeen;
    if( not userStats.get(name, timesSeen) )
    {
        timesSeen = 0;
    }
    
    // As the player just joined, we have to increase our timesSeen counter by 1
    timesSeen += 1;
    
    // And we store the updated value of our counter
    userStats.set(name, timesSeen);
    
    // Save the statistics
    userStats.save();
    
    // And instead of showing a global message, we'll now show a private message to this user.
    // The message will be different, depending on whether this is the first time that this user joined the server.
    if(timesSeen==1)
        server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
    else
        server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
}

// The playerChat event that will happen at every chat message
int playerChat(int uid, string msg)
{
    // Split the message on spaces
    array<string>@ arguments = msg.split(" ");
    
    // We need at least 1 argument in our message
    if(arguments.length()>=1)
    {
        // We only need to do something if the first word in the message is the command (first word = argument 0)
        if( arguments[0] == "!seen" )
        {
            // For this command, we'll need at least 2 arguments in the message (the command itself, and a uid)
            if(arguments.length()<2)
            {
                server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                server.say("Example: !seen 152", uid, FROM_SERVER);
            }
            else
            {
                // The second word should be the unique identifier of the user of whom we want to get the statistics of
                int buid = parseInt(arguments[1]);
                
                // Get the username that matches the unique identifier
                string name = server.getUserName(buid);
                
                // The getUserName function returns something empty when the requested uid is not online
                if(name=="")
                {
                    server.say("!seen shows join statistics of a certain user.", uid, FROM_SERVER);
                    server.say("Usage:   !seen <uid>", uid, FROM_SERVER);
                    server.say("Example: !seen 152", uid, FROM_SERVER);
                }
                else
                {
                    // Get the amount of times that we've seen the player before
                    int timesSeen;
                    if( not userStats.get(name, timesSeen) )
                    {
                        timesSeen = 0;
                    }
                    
                    // And show it as output to the user that requested it
                    server.say("User " + name + " (" + buid + ") has been seen " + timesSeen + " times on this server.", uid, FROM_SERVER);
                }
            }
        }
    }
    
    // You can change broadcasting levels using this function, but here, we'll change nothing by returning BROADCAST_AUTO
    return BROADCAST_AUTO;
} 

So, now you have a system that will keep track of usernames. Possible further additions that you can make:

• Allow the !seen command to search on names instead of unique identifiers.
• Add the relative time when a user was last seen.
• Keep track of how much time a user spends on the server.
• Allow the script to be used by multiple running servers (use the servername or server port to create seperate filenames for each server)
• ...

Just for the record (to keep this on topic ), here's the script rewritten as chat plugin for the script wrappers earlier in this thread:

• chatPlugin_joinStats.as
  

  #include "utils.as"
  #include "chatManager.as"
  
  void chatPlugin_joinStats_seenCommand(chatMessage@ cmd)
  {
      chatPlugin_joinStats@ obj;
      cmd.argument.retrieve(@obj);
      obj.callback_seenCommand(cmd);
  }
  
  class chatPlugin_joinStats
  {
      // Create our dictionary as global variable
      localStorage@ userStats;
      
      // A reference to the chat manager
      chatManager@ chtmngr;
      
      // internal flag
      bool registered;
      
      
      chatPlugin_joinStats(chatManager@ _chtmngr)
      {
          @chtmngr = @_chtmngr;
  
          // Register the callbacks
          chtmngr.addCommand("seen", @chatPlugin_joinStats_seenCommand, @any(@this), true, AUTH_ALL);
          server.setCallback("playerAdded", "playerAdded", @this);
          
          // Load the statistics file
          @userStats = @localStorage("userJoinStatistics.asdata");
          
          registered = true;
      }
  
      ~chatPlugin_joinStats()
      {
          destroy();
      }
  
      void destroy()
      {
          if(registered)
          {
              chtmngr.removeCommand("seen");
              server.deleteCallback("playerAdded", "playerAdded", @this);
              registered = false;
          }
      }
      
      // This function will get called when a player joins the game
      void playerAdded(int uid)
      {
          // Create a new variable holding the username
          string name = server.getUserName(uid);
          
          // Get the amount of times that we've seen this player before
          int timesSeen;
          if( not userStats.get(name, timesSeen) )
          {
              timesSeen = 0;
          }
          
          // As the player just joined, we have to increase our timesSeen counter by 1
          timesSeen += 1;
          
          // And we store the updated value of our counter
          userStats.set(name, timesSeen);
      
          // Save the statistics
          userStats.save();
          
          // And instead of showing a global message, we'll now show a private message to this user.
          // The message will be different, depending on whether this is the first time that this user joined the server.
          if(timesSeen==1)
              server.say("Welcome " + name + ", thank you for deciding to check out our server!", uid, FROM_HOST);
          else
              server.say("Welcome back " + name + ", this is the " + timesSeen + "th time that you joined our server :D", uid, FROM_HOST);
      }
  
      void callback_seenCommand(chatMessage@ cmsg)
      {
          // We need at least 1 argument and that argument needs to be a number
          if(cmsg.emsgLen<2 || !isNumber(cmsg.emsg[1]))
          {
              cmsg.privateGameCommand.message("!seen shows join statistics of a certain user.", "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Usage:   !seen <uid>",                           "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Example: !seen 152",                             "information.png", 30000.0f, true);
              return;
          }
          
          // The second word should be the unique identifier of the user of whom we want to get the statistics of
          int buid = parseInt(cmsg.emsg[1]);
                      
          // Get the username that matches the unique identifier
          string name = server.getUserName(buid);
                      
          // The getUserName function returns something empty when the requested uid is not online
          if(name=="")
          {
              cmsg.privateGameCommand.message("!seen shows join statistics of a certain user.", "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Usage:   !seen <uid>",                           "information.png", 30000.0f, true);
              cmsg.privateGameCommand.message("Example: !seen 152",                             "information.png", 30000.0f, true);
              return;
          }
          
          // Get the amount of times that we've seen the player before
          int timesSeen;
          if(!userStats.get(name, timesSeen))
              timesSeen = 0;
          
          // And show it as output to the user that requested it
          cmsg.privateGameCommand.message("User " + name + " (" + buid + ") has been seen " + timesSeen + " times on this server.", "chart_bar.png", 30000.0f, true);
      }
  } 

• your script file
  << php >>

(also, I've just updated the attachment of the first post, as there was a small bug in the localStorage.as file (line 262)).

BTW, Do you know if the Server Auto restart goes under the script file if it fails to run? because i get "heartbeat faliures" i dont know why

[graysonk95]

I can't get the included scripts to work, the server says "Unknown error while adding a new script from file"


Nevermind, I probably should have opened it to check if everything was set up right first.

[neorej16]

BTW, Do you know if the Server Auto restart goes under the script file if it fails to run? because i get "heartbeat faliures" i dont know why

There are 2 possible types of script failures:
- The server failed to load/parse the script => the server will run as if there was no script
- An error occurs during script execution => An exception will be logged in the logfile, but the server will continue calling script events.
The script should never cause the server to shut down or crash.

The heartbeat failures have to do with the communication with the master server.
Every minute, a rorserver reports to the master server a list of online players. As long as the master server receives this report every minute, your server will stay in the serverlist.
The heartbeat failure means that something went wrong while sending the report to the master server. Basicly, this will usually mean that you couldn't connect to the master server or that the connection was broken while sending the report (or while waiting for the response).

So, if you get heartbeat failures, then there may be a problem with your connection or the connection of the master server. If the connection problem persists, then your rorserver will shut down (which will happen after 5 consequent heartbeat failures), but this has nothing to do with the scripts.

[EBs Servers]

automatically restart crashed servers  the rorserver init script will check if a server is running before starting it up. Thus its safe to just execute: 
 /etc/init.d/rorserver start via a cron job. It will just start a server, if its process is not running anymore (crashed). 

[dogy]

Just a quick question: Is it possible to run the server with parental controls? Because I keep getting this message:
---UPDATE---
Also a compliment: I tried make a server about 7 months ago and failed because I didn't get what the heck the wiki was telling me, then i saw this and i completely understand now. Thanks for your help!

[neorej16]

Just a quick question: Is it possible to run the server with parental controls? Because I keep getting this message:
---UPDATE---
Also a compliment: I tried make a server about 7 months ago and failed because I didn't get what the heck the wiki was telling me, then i saw this and i completely understand now. Thanks for your help!

The root error is the "message does not contain a body". This is probably caused by your firewall or router, but I've never encountered this problem myself, so I'm not sure what would fix it.

[anonymous1]

Message does not appear to contain a body

Please make sure that your terrain name doesn't contain any spaces. If you're not using the servergui, then also make sure that your server name doesn't contain spaces.

---

Source: Server_Setup_Tutorial#Troubleshooting.

[EBs Servers]

For example: China town will result in a fail...
China_Town is the correct server name
You have to use the "_" symbol when using a space between the name

The root error is the "message does not contain a body". This is probably caused by your firewall or router, but I've never encountered this problem myself, so I'm not sure what would fix it.

[dogy]

For example: China town will result in a fail...
China_Town is the correct server name
You have to use the "_" symbol when using a space between the name

I did all that already. Like neorej16 said: "This is probably caused by your firewall or router, but I've never encountered this problem myself,..." its probably because of the Parental Controls which the firewall is probably blocking it. Also hear is the full message(NOTE: 2 Images):

- - - Updated - - -

So it is probably the Parental Controls with the Firewall.

[EBs Servers]

I did all that already. Like neorej16 said: "This is probably caused by your firewall or router, but I've never encountered this problem myself,..." its probably because of the Parental Controls which the firewall is probably blocking it. Also hear is the full message(NOTE: 2 Images):

- - - Updated - - -

So it is probably the Parental Controls with the Firewall.

Okay. You need to port forward. Make an exception in your firewall to let the Program run and host the server.
Find the External IP of the hosting computer.
Paste it into the server cmd file
Make sure you select the Host ip internal to use and create the port with.

[dogy]

Okay. You need to port forward. Make an exception in your firewall to let the Program run and host the server.
Find the External IP of the hosting computer.
Paste it into the server cmd file
Make sure you select the Host ip internal to use and create the port with.

How would you port forward a computer with no router but a modem. Because i tried to port forward it but failed because it would not give me any access through the modem.

[anonymous1]

How would you port forward a computer with no router but a modem. Because i tried to port forward it but failed because it would not give me any access through the modem.

Modems don't need port forwarding. Port forwarding allow a router to pass a Public IP address. You need a broadband line, allowing you to port forward your router.

[dogy]

Modems don't need port forwarding. Port forwarding allow a router to pass a Public IP address. You need a broadband line, allowing you to port forward your router.

What do you mean by a broadband line? Also i did some exploring and i was told i had to make my ip static also, when i did that i got this:

[JDM]

These are some of the best scripts i used Thanks