/*
TShock, a server mod for Terraria
Copyright (C) 2011-2019 Pryaxis & TShock Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
*/
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Text;
using Newtonsoft.Json;
namespace TShockAPI.Configuration
{
///
/// Settings used to configure server side characters
///
public class SscSettings
{
///
/// Enable server side characters, causing client data to be saved on the server instead of the client.
///
[Description("Enable server side characters, causing client data to be saved on the server instead of the client.")]
public bool Enabled = false;
///
/// How often SSC should save, in minutes.
///
[Description("How often SSC should save, in minutes.")]
public int ServerSideCharacterSave = 5;
///
/// Time, in milliseconds, to disallow discarding items after logging in when ServerSideCharacters is ON.
///
[Description("Time, in milliseconds, to disallow discarding items after logging in when ServerSideCharacters is ON.")]
public int LogonDiscardThreshold = 250;
///
/// The starting default health for new players when SSC is enabled.
///
[Description("The starting default health for new players when SSC is enabled.")]
public int StartingHealth = 100;
///
/// The starting default mana for new players when SSC is enabled.
///
[Description("The starting default mana for new players when SSC is enabled.")]
public int StartingMana = 20;
///
/// The starting default inventory for new players when SSC is enabled.
///
[Description("The starting default inventory for new players when SSC is enabled.")]
public List StartingInventory = new List();
///
/// Warns players that they have the bypass SSC permission enabled. To disable warning, turn this off.
///
[Description("Warns players and the console if a player has the tshock.ignore.ssc permission with data in the SSC table.")]
public bool WarnPlayersAboutBypassPermission = true;
/// If set to true, items given to players will be inserted directly into their inventory. Requires SSC. Otherwise, items given to players will spawn as dropped items.
[Description("If set to true, items given to players will be inserted directly into their inventory. Requires SSC. Otherwise, items given to players will spawn as dropped items.")]
public bool GiveItemsDirectly = false;
}
///
/// Configuration for the server side characters system
///
public class ServerSideConfig : ConfigFile
{
///
/// Dumps all configuration options to a text file in Markdown format
///
public static void DumpDescriptions()
{
var sb = new StringBuilder();
var defaults = new SscSettings();
foreach (var field in defaults.GetType().GetFields().OrderBy(f => f.Name))
{
if (field.IsStatic)
continue;
var name = field.Name;
var type = field.FieldType.Name;
var descattr =
field.GetCustomAttributes(false).FirstOrDefault(o => o is DescriptionAttribute) as DescriptionAttribute;
var desc = descattr != null && !string.IsNullOrWhiteSpace(descattr.Description) ? descattr.Description : "None";
var def = field.GetValue(defaults);
sb.AppendLine("## {0} ".SFormat(name));
sb.AppendLine("{0}".SFormat(desc));
sb.AppendLine("* **Field type**: `{0}`".SFormat(type));
sb.AppendLine("* **Default**: `{0}`".SFormat(def));
sb.AppendLine();
}
File.WriteAllText("docs/ssc-config.md", sb.ToString());
}
}
}