[Zirconium]

Description : Displays the Server's Rules to all players each XX seconds, or on demand for the current player when asking for them using !rules or /rules in chat command.

CVARs :

scrollingrules_version
The version of this plugin, don't forget to change it in your existing cfg file when you update the plugin.

scrollingrules_enabled
Enables/Disable displaying the scrolling rules. (0 = disabled, 1 = enabled)
Default 1 = enabled

scrollingrules_howto
Enable/Disable the display of "How To" message like "type !rules in chat to view our rules". (0 = disabled, 1 = enabled)
Default 1 = enabled

scrollingrules_howto_delay
Amount of seconds before the "How To" message is shown after map has started.
Default 20 seconds

scrollingrules_interval
Amount of seconds between each "group" of rules scrolling automaticaly in chat.
Default 300 seconds

scrollingrules_delay
Amount of seconds between each rule line scrolling when "on demand".
Default 0.2 seconds

scrollingrules_autodelay
Amount of seconds between each rule line scrolling when "auto scrolling".
Default 0.5 seconds

scrollingrules_file File to read the scrolling rules from, located in /translations dir.
Default: scrollingrulesdata.phrases.txt


The plugin, by default, reads the 'rules' from translations/scrollingrulesdata.phrases.txt, which has this format:

        "Phrases"
        {
            "Rule01"
            {
                "en"        "{red}This are our Server Rules !"
            }
            "Rule02"
             {
                 "en"        "{red}Follow them {default}or you'll be {red}kicked {default}from Server"
             }
             ....
             "Rule10"
             {
                 "en"        "'=================================================="
...
         }

Other language files in translations/de/scrollingrulesdata.phrases.txt, for german :

        "Phrases"
        {
            "Rule01"
            {
               "de"       "{red}Dass sind unsere Regeln !"
            }
             "Rule02"
             {
                 "de"        "{red}Beobachtet Sie {default}oder sie werden vom Server {red}gekickt"'
             }
             ....
             "Rule10"
             {
                 "de"        "=================================================="
...
         }

or translations/fr/scrollingrulesdata.phrases.txt for french:

        "Phrases"
        {
            "Rule01"
            {
                "fr"        "{red}Voici nos Règles !"
            }
            "Rule02"
             {
                "fr"        "{red}Respectez les ou vous serez Kické"
             }
             ....
             "Rule10"
             {
                 "fr"        "=================================================="
...
         }

or in translations/$lang/scrollingrulesdata.phrases.txt for $lang language where $lang is a language code existing in sourcemod/configs/language.cfg on your server!!!

For more info about languages and translations look HERE

Each language file must have the same Sections names inside.

Keep this file structure or the plugin won't work (sections names HAVE TO CONTAIN THE WORD 'Rule', like 'Rule01' or 'Rule Line 2' etc...) .

If you have [INC]Colors installed you can use color codes in your rules file by uncommenting the //#define USECOLORS and recompile the plugin at your own. If it's NOT installed DON'T USE COLOR TAGS or it won't give you colored text.

WARNING
=======
With version 0.1.0 [INC]Colors has been be replaced by [INC]Morecolors when enabling USECOLORS you'll need to use sourcemod >= version1.5 to compile it if you start from source.
Two versions are now included, one with USECOLORS activated and the other without it, so you don't need to compile, just choose your version and rename it to scrollingrules.smx after download.


Installation :

Put the scrollingrules.phrases.txt file in your %GAMEDIR%/addons/sourcemod/translations directory, this is used to have translation on "How To" message.

Put the scrollingrulesdata.phrases.txt file in your %GAMEDIR%/addons/sourcemod/translations directory, this is used as rules KV file and for rules translation.

Put the scrollingrules.smx file in your %GAMEDIR%/addons/sourcemod/plugins directory.

The scrollingrules.cfg file in your %GAMEDIR%/cfg/sourcemod directory will be auto-generated because AutoExecConfig(true, "scrollingrules"); is set on plugin start, just edit this file if you want to modifiy default values to yours.


Changelog :

• 0.0.1
  • Initial version (be indulgent it's my first plugin )

• 0.0.2
  • Changed to KV file no more rules number limit

• 0.0.3
  • Fixed some warning coding errors
  • #define USECOLORS is not set as default in .smx version
  • scrollingrules.cfg file is 'auto-generated' if not existing at plugin start
• 0.0.4
  • Using a translation file for getting rules translated in chat.
• 0.0.5
  • Fixed index problem in SendToAllMsg when server is empty
• 0.0.6
  • Fixed warning error "KillTimer" on OnMapStart
• 0.0.7
  • Using PrintToChat and CPrintToChat translation capabilities
  • Added a scrolllingrules_howto_delay var
  • Added a "Start message" in console when plugin starts
• 0.0.8
  • Fixed global warnings with "KillTimer"
    
  • translations files examples are provided without color tags inside

• 0.0.9
  • Fixed KillTimer warning message on map change.

• 0.1.0
  • Changed from colors.inc to morecolors.inc and updating for sourcemod 1.5.0. Two versions are now included, one with USECOLORS activated and the other without it, so you don't need to compile, just choose your version and rename it after download.

• 0.1.1
  • updated for sourcemod 1.8.0. and fixed warning messages concerning FCVAR_PLUGIN.

• 1.0.0
  • solved {teamcolor} issue in welcome message. Version is now fully functional.

Screenshots

[Kjaer]

Might wanna up the rule max.

[Antithasys]

The hardcoded array used to display the rules is very odd indeed. While it is necessary to know the name of the translation file, using a scheme would appear appropriate here, and it looks like you already made one.

"RuleX" can be used. This would make the rule count almost unlimited. Since the phrases file is just a KV file, the number of sections could easily be read into a global variable and all you to append the "RuleX" string to continually get the next rule in a loop. Or something, this is just off the top of my head.

[desynced]

Plugin failed to compile! Please try contacting the author.

[Zirconium]

to desynced which errors did you get ??

try to comment out the #define USECOLORS maybe you don't have colors.inc in your inc files list.


to Antithasys :

Originally Posted by Antithasys The hardcoded array used to display the rules is very odd indeed. While it is necessary to know the name of the translation file, using a scheme would appear appropriate here, and it looks like you already made one.

ermmm sorry m8, but i don't know yet how to use KV file with translations , but i'm working "hard" to learn it .

Originally Posted by Antithasys "RuleX" can be used. This would make the rule count almost unlimited. Since the phrases file is just a KV file, the number of sections could easily be read into a global variable and all you to append the "RuleX" string to continually get the next rule in a loop. Or something, this is just off the top of my head.

When i solved first point i'll try to do it like you proposed , the point is, the same file is used to "auto scroll" rules and when !rules (sm_rules) is asked by a player !!

[Antithasys]

Some suggestions:

Create a global to get the total number of rules.

PHP Code:

//total amount of rules in file.
//get this from counting kv sections in some function
new g_iTotalRules = 0; 


Then when you need to load the rules into the message que, or whatever.

PHP Code:

for (new i = 1; i <= g_iTotalRules; i++)
{
    decl String:sBuffer[256];
    Format(sBuffer, sizeof(sBuffer), "Rule%i", i);
    Format(sBuffer, sizeof(sBuffer), "%T", sBuffer);
    AddMsgToAllQueue(client, sBuffer);
} 


What the above loop does is append the word 'Rule' with a number that increases... like 1, 2, 3, 4, etc... It then gets the translation for that new string and stores it. Then adds it to the queue. This way you don't need to know the literal translation phrase or the total amount of rules.

*While I didn't solve all your problems, this should get you going in the right direction.

[Zirconium]

to Antithasys :

If you could have a look at what i did and tell me if it's ok or not it would be great.

Not sure i did well

Thanks for your help.

[Zirconium]

I'll try it with KV file like this, hope it 'll work (a scrollingrulesdata.phrases.txt file from translations dir will be loaded and used to translate and also as KV file)

PHP Code:

...
LoadTranslations("myplugin.phrases");
...
    BuildPath(Path_SM, sPath, sizeof(sPath), "translations/%s", sFile);
    if (FileExists(sPath)) {
        FileToKeyValues(g_hRules, sPath);
        // Moves to the FIRST SubKey level before reading
        KvGotoFirstSubKey(g_hRules);
        // Loop for reading all rules
...
        do
        {
            // Get the Section's Name to use it for getting translations 
            KvGetSectionName(kv, sSectionName, sizeof(sSectionName));
            // Send the rule text to client's message queue using translations
            if (StrContains(sSectionName, "Rule", true) != -1 ) {
                new String:sMsg[255];
                // Formating the message string with translation file
                Format(sMsg, sizeof(sMsg), "%t" , sSectionName, client);
                AddMsgToQueue(client, sMsg);
            } 
        } while (KvGotoNextKey(kv));
        
...

stock bool:AddMsgToQueue(iClient, const String:szMessage[], any:...) {
    if (!IsClientInGame(iClient)) {
        return false;
    }
    new String:szFormattedMsg[64];
    VFormat(szFormattedMsg, sizeof(szFormattedMsg), szMessage, 3);
    PushArrayCell(g_hUserIdQueue, GetClientUserId(iClient));
    PushArrayString(g_hMsgQueue, szFormattedMsg);
    
    if (g_hMsgTimer == INVALID_HANDLE) {
        g_hMsgTimer = CreateTimer(GetConVarFloat(g_hDelay) * 1.0, Timer_SendMsg, _, TIMER_REPEAT);
    }
    return true;
}
...
public Action:Timer_SendMsg(Handle:timer) {
    if (!GetArraySize(g_hMsgQueue)) {
        g_hMsgTimer = INVALID_HANDLE;
        return Plugin_Stop;
    }
    new String:szMessage[64];
    GetArrayString(g_hMsgQueue, 0, szMessage, sizeof(szMessage));
    new iClient = GetClientOfUserId(GetArrayCell(g_hUserIdQueue, 0));
    if (IsPlaying(iClient)) {
        #if defined USECOLORS
            CPrintToChat(iClient, szMessage);
        #else
            PrintToChat(iClient, szMessage);
        #endif        
    }
    RemoveFromArray(g_hMsgQueue, 0);
    RemoveFromArray(g_hUserIdQueue, 0);
    return Plugin_Handled;
}  

... 


This is working not too bad, my only problem now is i can't get the first rule section printed because it seems it's not detected correctly.
I hope i'll reach to solve this last point, if someone has an idea ?

Ok problem is solved, was an encoding problem with my phrases.txt file, switched to UTF8 without BOM, put the files in different translations subdir for each corresponding language and now all is working

[Zirconium]

Plugin is working good since a couple of days, hope someone will look at it and why not approve it if it's ok for it.

[Spunkie]

Would love to get a couple of screenshots or a demo video in your original post. ^_^