gamemode/daemon/daemon_config.h
Marc Di Luzio db8a70b7ba Add support for user defined local script plugins
A much requested feature, this allows for providing custom scripts in the config file. An example in the man page is below and would trigger both a system notification, and allow control over a background crypto mining script automatically in gamemode.

	[custom]
	; Custom scripts (executed using the shell) when gamemode starts and ends
	start=notify-send "GameMode started"
	    /home/me/bin/stop_ethmining.sh

	end=notify-send "GameMode ended"
	    /home/me/bin/start_ethmining.sh

	Scripts are run with system() and do not have any special privilages, as with the rest of the daemon, custom scripts that require root will need their own permissions set up externally.

	This commit also renames two defines as they needed to be moved to the public interface.
2018-04-24 16:59:17 +01:00

96 lines
3.0 KiB
C

/*
Copyright (c) 2017-2018, Feral Interactive
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Feral Interactive nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <stdbool.h>
/*
* Maximum sizes values in a config list
* In practice inih has a INI_MAX_LINE value of 200 so the length is just a safeguard
*/
#define CONFIG_LIST_MAX 32
#define CONFIG_VALUE_MAX 256
/*
* Opaque config context type
*/
typedef struct GameModeConfig GameModeConfig;
/*
* Initialise a config
*/
GameModeConfig *config_create(void);
/*
* Initialise a config
* Must be called before using any config later config functions
*/
void config_init(GameModeConfig *self);
/*
* Reload a config from disk
* Thread safe to call
*/
void config_reload(GameModeConfig *self);
/*
* Destroy a config
* Invalidates the config
*/
void config_destroy(GameModeConfig *self);
/*
* Get if the client is in the whitelist
* returns false for an empty whitelist
*/
bool config_get_client_whitelisted(GameModeConfig *self, const char *client);
/*
* Get if the client is in the blacklist
*/
bool config_get_client_blacklisted(GameModeConfig *self, const char *client);
/*
* Get the frequency (in seconds) for the reaper thread
*/
long config_get_reaper_thread_frequency(GameModeConfig *self);
/*
* Get a set of scripts to call when gamemode starts
*/
void config_get_gamemode_start_scripts(GameModeConfig *self,
char scripts[CONFIG_LIST_MAX][CONFIG_VALUE_MAX]);
/*
* Get a set of scripts to call when gamemode ends
*/
void config_get_gamemode_end_scripts(GameModeConfig *self,
char scripts[CONFIG_LIST_MAX][CONFIG_VALUE_MAX]);