AlliedModders - [INC] Append new ConVars to plugin config v2.1

AlliedModders (https://forums.alliedmods.net/index.php)

- Snippets and Tutorials (https://forums.alliedmods.net/forumdisplay.php?f=112)

- - [INC] Append new ConVars to plugin config v2.1 (https://forums.alliedmods.net/showthread.php?t=233282)

[INC] Append new ConVars to plugin config v2.1

Ciao,

I made a simple replacement for AutoExecConfig ;-)

PHP Code:


		
			
/**
 * Append new ConVars to config file on new plugin version.
 *
 * @param name            Name of the config file, excluding the .cfg extension.
 *                        If empty, <plugin.filename.cfg> is assumed.
 * @param folder          Folder under cfg/ to use.  By default this is "sourcemod."
 * @param AppendNote      Note for server master about appended ConVars or just about appending.
 * @param AlwaysAppend    Always try to append new ConVars and do not look at plugin version. (useful for developer release)
 *
 * @noreturn
 */
stock AutoExecConfigAppend( const String:name[] = "", const String:folder[] = "sourcemod", String:AppendNote[ 512 ] = "", bool:AlwaysAppend = false )

When is config updating?

When plugin version is not written in config file (those "// @version:" lines).
When AlwaysAppend = true

Note: You will see all your ConVars on server console when is config updating.

Implementing:

#include <convar_append>
Replace "AutoExecConfig" with "AutoExecConfigAppend" - no special functions for creating convars etc. needed.

Note: AutoExecConfigAppend will log message about appending ConVars to SourceMod logs.

Important note: If AutoExecConfigAppend do not append all ConVars, change "#define CONVAR_APPEND_MAXCHARS 4096" to higher value (in convar_append.inc line 7).

Example:

Spoiler

plugin release v0.1

PHP Code:


		
			
#include <sourcemod>
#include <convar_append>

public Plugin:myinfo =
{
    name = "TestConVarsList",
    author = "Raska",
    description = "TestConVarsList",
    version = "0.1",
    url = ""
}

public OnPluginStart()
{
    CreateConVar( "sm_cvar1",    "1",         "ConVar description for cvar 1..." );
    CreateConVar( "sm_cvar3",     "3.5",     "ConVar description for cvar 3..." );
    CreateConVar( "sm_cvar4",     "Ciao",     "ConVar description for cvar 4..." );
    
    AutoExecConfigAppend();
}

and config would be like:

Code:

// Append new ConVars for plugin TestConVarsList.smx

// @version: 0.1



// ConVar description for cvar 1...

// -

// Default: "1"

sm_cvar1 "1"



// ConVar description for cvar 3...

// -

// Default: "3.5"

sm_cvar3 "3.5"



// ConVar description for cvar 4...

// -

// Default: "Ciao"

sm_cvar4 "Ciao"

plugin release v0.2

PHP Code:


		
			
#include <sourcemod>
#include <convar_append>

public Plugin:myinfo =
{
    name = "TestConVarsList",
    author = "Raska",
    description = "TestConVarsList",
    version = "0.2",
    url = ""
}

public OnPluginStart()
{
    CreateConVar( "sm_cvar1",    "1",         "ConVar description for cvar 1..." );
    CreateConVar( "sm_cvar3",     "3.5",     "ConVar description for cvar 3..." );
    CreateConVar( "sm_cvar4",     "Ciao",     "ConVar description for cvar 4..." );
    CreateConVar( "sm_cvar7",     "7",         "ConVar\n description\n for\n cvar\n 7...\n (multiline)" );
    CreateConVar( "sm_cvar8",     "8.4",     "ConVar description for cvar 8...", _, true, 0.0, true, 96.53 );
    CreateConVar( "sm_cvar9",     "-6.5",     "ConVar description for cvar 9...", _, false, _, true, 10.0 );
    
    AutoExecConfigAppend( _, _, "Just a little note about this ConVar append..\n\t- Delete ConVar sm_cvar3\n\t- ConVar sm_cvar7 is not integer but float now!" );
}

and config would be like:

Code:

// Append new ConVars for plugin TestConVarsList.smx

// @version: 0.1



// ConVar description for cvar 1...

// -

// Default: "1"

sm_cvar1 "1"



// ConVar description for cvar 3...

// -

// Default: "3.5"

sm_cvar3 "3.5"



// ConVar description for cvar 4...

// -

// Default: "Ciao"

sm_cvar4 "Ciao"



// Append new ConVars for plugin TestConVarsList.smx

// @version: 0.2

// @note: Just a little note about this ConVar append..

//         - Delete ConVar sm_cvar3

//         - ConVar sm_cvar7 is not integer but float now!



// ConVar

//  description

//  for

//  cvar

//  7...

//  (multiline)

// -

// Default: "7"

sm_cvar7 "7"



// ConVar description for cvar 8...

// -

// Default: "8.4"

// Minimum: "0.000000"

// Maximum: "96.529998"

sm_cvar8 "8.4"



// ConVar description for cvar 9...

// -

// Default: "-6.5"

// Maximum: "10.000000"

sm_cvar9 "-6.5"

And log message looks like this:

Code:

L 01/30/2014 - 19:07:16: [TestConVarsList.smx] ConVars appended to file "cfg/sourcemod/plugin.TestConVarsList.cfg" (version: "0.2")

Against my testing, there might be some bugs.. So let me know if you find someone please.

Change log:

Spoiler

Re: [INC] Append new ConVars to plugin config

What's the different between this and the one Impact123 wrote?

Re: [INC] Append new ConVars to plugin config

You don't need to use special functions for creating ConVars etc.. This is easier to use.

Re: [INC] Append new ConVars to plugin config

Couldn't you just load the configuration file, delete it and then let AutoExecConfig create it again ?
This way it should add all Cvars automatically and would be just a few lines of code.

Re: [INC] Append new ConVars to plugin config

the point of a configuration file is to save the configuration, not to delete it... It will put all cvars to default values which is unwanted but your idea it not totally wrong but would still need a new AutoExecConfig external since my idea was to load the cvars, delete old configs, and create new one (from scratch and not from sourcemod) to add the cvars at their current values plus the new cvars.

Re: [INC] Append new ConVars to plugin config

And even if the new file generated by AutoExecConfig saved the current values rather than the defaults... Deleting the file would remove any comments that the server op may have placed in there.

Re: [INC] Append new ConVars to plugin config

Quote:

Originally Posted by Black-Rabbit (Post 2087470)

No, the way I meant it would preserve the current values, not delete them.
I haven't find anything in the documentation, that the default values are used instead of the current ones, but yeah it of course doesn't work then.
It was just an idea how to maybe get away with less code.

Quote:

Originally Posted by ddhoward (Post 2087476)

And even if the new file generated by AutoExecConfig saved the current values rather than the defaults... Deleting the file would remove any comments that the server op may have placed in there.

That would be a very tiny downside when they get lost on plugin update. I don't remember ever having put comments in generated config files in 5 years. But there are maybe people who do that.

Re: [INC] Append new ConVars to plugin config

Quote:

Originally Posted by ddhoward (Post 2087476)

And even if the new file generated by AutoExecConfig saved the current values rather than the defaults... Deleting the file would remove any comments that the server op may have placed in there.

comment a config, lol...

Re: [INC] Append new ConVars to plugin config

What's wrong with commenting configs?

If this saved new values in your cfg instead of making them default again, I'd use it!

Unless it already does, and I just misread.

Re: [INC] Append new ConVars to plugin config

I plan to make a better and smarter version after my exams, this is a little messy version.. O:-)