Skip to content

feature: Allow providing default game settings along with your game #2761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Arufonsu merged 4 commits into from
Dec 1, 2025
Merged

feature: Allow providing default game settings along with your game #2761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8feb205
Allow providing default game settings along with your game
jcsnider Nov 30, 2025
775a428
Determine default keybinds from default_settings.json. Fallback on ha…
jcsnider Nov 30, 2025
f7ab054
Cleanup. Working and ready to merge.
jcsnider Nov 30, 2025
2890ab4
Implementing Aru recommendations
jcsnider Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions Intersect.Client.Framework/Database/JsonDatabase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ public JsonDatabase()
_ = TryOpenOrCreate(_instancePath, out _instance);
}

public JsonDatabase(string path)
{
_instancePath = path;
_ = TryOpenOrCreate(_instancePath, out _instance);
}

private static string GetInstancePath(ClientConfiguration instance)
{
return Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), ".intersect",
Expand All @@ -38,10 +44,19 @@ private bool TryOpenOrCreate(string instancePath, [NotNullWhen(true)] out JObjec
fileInfo.Directory.Create();
}

using var streamWriter = fileInfo.CreateText();
streamWriter.WriteLine("{}");
instance = new JObject();
return true;
//Allow game devs to provide default settings
var defaultSettingsJson = Path.Combine("resources", "default_settings.json");
if (File.Exists(defaultSettingsJson))
{
File.Copy(defaultSettingsJson, instancePath);
}
else
{
using var streamWriter = fileInfo.CreateText();
streamWriter.WriteLine("{}");
instance = new JObject();
return true;
}
}

using var streamReader = fileInfo.OpenText();
Expand Down
136 changes: 91 additions & 45 deletions Intersect.Client.Framework/Input/BuiltinControlsProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,13 @@
using System.Diagnostics.CodeAnalysis;
using Intersect.Client.Framework.Database;
using Intersect.Client.Framework.GenericClasses;
using Newtonsoft.Json;

namespace Intersect.Client.Framework.Input;

internal sealed class BuiltinControlsProvider : IControlsProvider
{
private readonly Dictionary<Control, ControlMapping> _defaultMappings = new()
{
{ Control.MoveUp, new ControlMapping(new ControlBinding(Keys.None, Keys.Up), new ControlBinding(Keys.None, Keys.W)) },
{ Control.MoveDown, new ControlMapping(new ControlBinding(Keys.None, Keys.Down), new ControlBinding(Keys.None, Keys.S)) },
{ Control.MoveLeft, new ControlMapping(new ControlBinding(Keys.None, Keys.Left), new ControlBinding(Keys.None, Keys.A)) },
{ Control.MoveRight, new ControlMapping(new ControlBinding(Keys.None, Keys.Right), new ControlBinding(Keys.None, Keys.D)) },
{ Control.AttackInteract, new ControlMapping(new ControlBinding(Keys.None, Keys.E), new ControlBinding(Keys.None, Keys.LButton)) },
{ Control.Block, new ControlMapping(new ControlBinding(Keys.None, Keys.Q), new ControlBinding(Keys.None, Keys.RButton)) },
{ Control.AutoTarget, new ControlMapping(new ControlBinding(Keys.None, Keys.Tab), ControlBinding.Default) },
{ Control.HoldToSoftRetargetOnSelfCast, new ControlMapping(new ControlBinding(Keys.None, Keys.LMenu), ControlBinding.Default) },
{ Control.ToggleAutoSoftRetargetOnSelfCast, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.PickUp, new ControlMapping(new ControlBinding(Keys.None, Keys.Space), ControlBinding.Default) },
{ Control.Enter, new ControlMapping(new ControlBinding(Keys.None, Keys.Enter), ControlBinding.Default) },
{ Control.Screenshot, new ControlMapping(new ControlBinding(Keys.None, Keys.F12), ControlBinding.Default) },
{ Control.OpenMenu, new ControlMapping(new ControlBinding(Keys.None, Keys.Escape), ControlBinding.Default) },
{ Control.OpenInventory, new ControlMapping(new ControlBinding(Keys.None, Keys.I), ControlBinding.Default) },
{ Control.OpenQuests, new ControlMapping(new ControlBinding(Keys.None, Keys.L), ControlBinding.Default) },
{ Control.OpenCharacterInfo, new ControlMapping(new ControlBinding(Keys.None, Keys.C), ControlBinding.Default) },
{ Control.OpenParties, new ControlMapping(new ControlBinding(Keys.None, Keys.P), ControlBinding.Default) },
{ Control.OpenSpells, new ControlMapping(new ControlBinding(Keys.None, Keys.K), ControlBinding.Default) },
{ Control.OpenFriends, new ControlMapping(new ControlBinding(Keys.None, Keys.F), ControlBinding.Default) },
{ Control.OpenGuild, new ControlMapping(new ControlBinding(Keys.None, Keys.G), ControlBinding.Default) },
{ Control.OpenSettings, new ControlMapping(new ControlBinding(Keys.None, Keys.O), ControlBinding.Default) },
{ Control.OpenDebugger, new ControlMapping(new ControlBinding(Keys.None, Keys.F2), ControlBinding.Default) },
{ Control.OpenAdminPanel, new ControlMapping(new ControlBinding(Keys.None, Keys.Insert), ControlBinding.Default) },
{ Control.ToggleGui, new ControlMapping(new ControlBinding(Keys.None, Keys.F11), ControlBinding.Default) },
{ Control.TurnAround, new ControlMapping(new ControlBinding(Keys.None, Keys.Control), ControlBinding.Default) },
{ Control.ToggleZoomIn, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.ToggleZoomOut, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.HoldToZoomIn, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.HoldToZoomOut, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.ToggleFullscreen, new ControlMapping(new ControlBinding(Keys.Alt, Keys.Enter), ControlBinding.Default) },

// Hotkeys should be at the end of the list
{ Control.Hotkey1, new ControlMapping(new ControlBinding(Keys.None, Keys.D1), ControlBinding.Default) },
{ Control.Hotkey2, new ControlMapping(new ControlBinding(Keys.None, Keys.D2), ControlBinding.Default) },
{ Control.Hotkey3, new ControlMapping(new ControlBinding(Keys.None, Keys.D3), ControlBinding.Default) },
{ Control.Hotkey4, new ControlMapping(new ControlBinding(Keys.None, Keys.D4), ControlBinding.Default) },
{ Control.Hotkey5, new ControlMapping(new ControlBinding(Keys.None, Keys.D5), ControlBinding.Default) },
{ Control.Hotkey6, new ControlMapping(new ControlBinding(Keys.None, Keys.D6), ControlBinding.Default) },
{ Control.Hotkey7, new ControlMapping(new ControlBinding(Keys.None, Keys.D7), ControlBinding.Default) },
{ Control.Hotkey8, new ControlMapping(new ControlBinding(Keys.None, Keys.D8), ControlBinding.Default) },
{ Control.Hotkey9, new ControlMapping(new ControlBinding(Keys.None, Keys.D9), ControlBinding.Default) },
{ Control.Hotkey10, new ControlMapping(new ControlBinding(Keys.None, Keys.D0), ControlBinding.Default) },
};
private readonly Dictionary<Control, ControlMapping> _defaultMappings = LoadDefaultMappings();

public Control[] Controls { get; } = Enum.GetValues<Control>().Where(control => control.IsValid()).ToArray();

Expand All @@ -67,5 +25,93 @@ public bool TryGetDefaultMapping(Control control, [NotNullWhen(true)] out Contro

public void ReloadFromOptions(Options? options)
{
// Builtin controls don't change based on options
// Defaults are loaded once from default_settings.json at initialization
}

/// <summary>
/// Loads default mappings by starting with hardcoded defaults and then merging overrides from default_settings.json if present.
/// </summary>
public static Dictionary<Control, ControlMapping> LoadDefaultMappings()
{
// Start with all hardcoded defaults
var defaults = GetHardcodedDefaults();

// Load default controls from default_settings.json
var defaultSettingsPath = Path.Combine("resources", "default_settings.json");
if (File.Exists(defaultSettingsPath))
{
var db = new JsonDatabase(defaultSettingsPath);

foreach (var control in defaults.Keys)
{
var controlId = control.GetControlId();
var bindings = new List<ControlBinding>();

if (db.HasPreference($"{controlId}_binding0") && db.HasPreference($"{controlId}_binding1"))
Comment thread
jcsnider marked this conversation as resolved.
{
var binding1 = JsonConvert.DeserializeObject<ControlBinding>(db.LoadPreference($"{controlId}_binding0"));
var binding2 = JsonConvert.DeserializeObject<ControlBinding>(db.LoadPreference($"{controlId}_binding1"));
if (binding1 != null && binding2 != null)
{
defaults[control] = new ControlMapping(binding1, binding2);
}
}
}
}

return defaults;
}

/// <summary>
/// Returns the hardcoded default control mappings.
/// </summary>
private static Dictionary<Control, ControlMapping> GetHardcodedDefaults()
{
return new Dictionary<Control, ControlMapping>
{
{ Control.MoveUp, new ControlMapping(new ControlBinding(Keys.None, Keys.Up), new ControlBinding(Keys.None, Keys.W)) },
{ Control.MoveDown, new ControlMapping(new ControlBinding(Keys.None, Keys.Down), new ControlBinding(Keys.None, Keys.S)) },
{ Control.MoveLeft, new ControlMapping(new ControlBinding(Keys.None, Keys.Left), new ControlBinding(Keys.None, Keys.A)) },
{ Control.MoveRight, new ControlMapping(new ControlBinding(Keys.None, Keys.Right), new ControlBinding(Keys.None, Keys.D)) },
{ Control.AttackInteract, new ControlMapping(new ControlBinding(Keys.None, Keys.E), new ControlBinding(Keys.None, Keys.LButton)) },
{ Control.Block, new ControlMapping(new ControlBinding(Keys.None, Keys.Q), new ControlBinding(Keys.None, Keys.RButton)) },
{ Control.AutoTarget, new ControlMapping(new ControlBinding(Keys.None, Keys.Tab), ControlBinding.Default) },
{ Control.HoldToSoftRetargetOnSelfCast, new ControlMapping(new ControlBinding(Keys.None, Keys.LMenu), ControlBinding.Default) },
{ Control.ToggleAutoSoftRetargetOnSelfCast, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.PickUp, new ControlMapping(new ControlBinding(Keys.None, Keys.Space), ControlBinding.Default) },
{ Control.Enter, new ControlMapping(new ControlBinding(Keys.None, Keys.Enter), ControlBinding.Default) },
{ Control.Screenshot, new ControlMapping(new ControlBinding(Keys.None, Keys.F12), ControlBinding.Default) },
{ Control.OpenMenu, new ControlMapping(new ControlBinding(Keys.None, Keys.Escape), ControlBinding.Default) },
{ Control.OpenInventory, new ControlMapping(new ControlBinding(Keys.None, Keys.I), ControlBinding.Default) },
{ Control.OpenQuests, new ControlMapping(new ControlBinding(Keys.None, Keys.L), ControlBinding.Default) },
{ Control.OpenCharacterInfo, new ControlMapping(new ControlBinding(Keys.None, Keys.C), ControlBinding.Default) },
{ Control.OpenParties, new ControlMapping(new ControlBinding(Keys.None, Keys.P), ControlBinding.Default) },
{ Control.OpenSpells, new ControlMapping(new ControlBinding(Keys.None, Keys.K), ControlBinding.Default) },
{ Control.OpenFriends, new ControlMapping(new ControlBinding(Keys.None, Keys.F), ControlBinding.Default) },
{ Control.OpenGuild, new ControlMapping(new ControlBinding(Keys.None, Keys.G), ControlBinding.Default) },
{ Control.OpenSettings, new ControlMapping(new ControlBinding(Keys.None, Keys.O), ControlBinding.Default) },
{ Control.OpenDebugger, new ControlMapping(new ControlBinding(Keys.None, Keys.F2), ControlBinding.Default) },
{ Control.OpenAdminPanel, new ControlMapping(new ControlBinding(Keys.None, Keys.Insert), ControlBinding.Default) },
{ Control.ToggleGui, new ControlMapping(new ControlBinding(Keys.None, Keys.F11), ControlBinding.Default) },
{ Control.TurnAround, new ControlMapping(new ControlBinding(Keys.None, Keys.Control), ControlBinding.Default) },
{ Control.ToggleZoomIn, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.ToggleZoomOut, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.HoldToZoomIn, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.HoldToZoomOut, new ControlMapping(ControlBinding.Default, ControlBinding.Default) },
{ Control.ToggleFullscreen, new ControlMapping(new ControlBinding(Keys.Alt, Keys.Enter), ControlBinding.Default) },

// Hotkeys should be at the end of the list
{ Control.Hotkey1, new ControlMapping(new ControlBinding(Keys.None, Keys.D1), ControlBinding.Default) },
{ Control.Hotkey2, new ControlMapping(new ControlBinding(Keys.None, Keys.D2), ControlBinding.Default) },
{ Control.Hotkey3, new ControlMapping(new ControlBinding(Keys.None, Keys.D3), ControlBinding.Default) },
{ Control.Hotkey4, new ControlMapping(new ControlBinding(Keys.None, Keys.D4), ControlBinding.Default) },
{ Control.Hotkey5, new ControlMapping(new ControlBinding(Keys.None, Keys.D5), ControlBinding.Default) },
{ Control.Hotkey6, new ControlMapping(new ControlBinding(Keys.None, Keys.D6), ControlBinding.Default) },
{ Control.Hotkey7, new ControlMapping(new ControlBinding(Keys.None, Keys.D7), ControlBinding.Default) },
{ Control.Hotkey8, new ControlMapping(new ControlBinding(Keys.None, Keys.D8), ControlBinding.Default) },
{ Control.Hotkey9, new ControlMapping(new ControlBinding(Keys.None, Keys.D9), ControlBinding.Default) },
{ Control.Hotkey10, new ControlMapping(new ControlBinding(Keys.None, Keys.D0), ControlBinding.Default) },
};
}
}
12 changes: 9 additions & 3 deletions Intersect.Client.Framework/Input/HotkeyControlsProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ namespace Intersect.Client.Framework.Input;

internal sealed class HotkeyControlsProvider : IControlsProvider
{
private Dictionary<Control, ControlMapping>? _defaultMappings = null;

public HotkeyControlsProvider() => Controls = ControlsFromOptions(Options.Instance);

public Control[] Controls { get; private set; }

public bool TryGetDefaultMapping(Control control, [NotNullWhen(true)] out ControlMapping? defaultMapping)
{
defaultMapping = null;
return false;
_defaultMappings ??= BuiltinControlsProvider.LoadDefaultMappings();
return _defaultMappings.TryGetValue(control, out defaultMapping);
}

private static Control[] ControlsFromOptions(Options? options) =>
Expand All @@ -21,5 +23,9 @@ private static Control[] ControlsFromOptions(Options? options) =>
.Select(hotkeyValue => Control.HotkeyOffset + hotkeyValue)
.ToArray();

public void ReloadFromOptions(Options? options) => Controls = ControlsFromOptions(options);
public void ReloadFromOptions(Options? options)
{
Controls = ControlsFromOptions(options);
_defaultMappings = null; // Force reload with new hotbar slot count
}
}
Loading