feat(prefs): add more pref keys

Author: KatoakDR

electron/main/preference/types.ts

@@ -2,26 +2,90 @@ import type { Maybe } from '../../common/types.js';
 
 export enum PreferenceKey {
   /**
-   * The window zoom factor (as a percentage).
+   * The app zoom factor (as a percentage).
+   * Scales the entire app window, text, etc just like in a browser.
    * 0.5 = 50%
    * 1.0 = 100%
    * 1.5 = 150%
    */
-  WINDOW_ZOOM_FACTOR = 'window.zoomFactor',
+  APP_ZOOM_FACTOR = 'app.zoomFactor',
   /**
-   * Whether to confirm before closing the window.
+   * Whether to confirm before closing the app.
    */
-  WINDOW_CONFIRM_ON_CLOSE = 'window.confirmOnClose',
+  APP_CONFIRM_CLOSE = 'app.confirmClose',
   /**
-   * The maximum number of lines to keep in any game stream.
+   * The maximum number of lines to display in each game window.
    */
-  GAME_STREAM_SCROLLBACK_BUFFER_SIZE = 'gameStream.scrollbackBufferSize',
+  GAME_WINDOW_SCROLLBACK_BUFFER_SIZE = 'game.window.scrollbackBufferSize',
+  /**
+   * The character to display when the game sends a prompt.
+   * Generally, this is the ">" character.
+   * To disable, set to an empty string.
+   */
+  GAME_WINDOW_PROMPT = 'game.window.prompt',
+  /**
+   * When a user submits a command, this is the separator character
+   * that will be used to split the command into multiple commands.
+   *
+   * For example, if the separator is ";" and the user submits
+   * "go bank; go window" then the app will send to the game two
+   * commands: "go bank" and "go window".
+   *
+   * Success of performing the sequential commands depends on factors like
+   * roundtime incurred, game mechanics, and the account's type-ahead limits.
+   */
+  GAME_COMMAND_SEPARATOR = 'game.command.separator',
+  /**
+   * The minimum length of a command to save it in the command history.
+   */
+  GAME_COMMAND_HISTORY_MIN_LENGTH = 'game.command.historyMinLength',
+  /**
+   * Absolute path to the Ruby executable.
+   * Windows Example: "C:\path\to\Ruby4Lich\bin\ruby.exe"
+   * macOS Example: "/path/to/.rbenv/shims/ruby"
+   */
+  RUBY_PATH = 'lich.rubyPath',
+  /**
+   * Absolute path to the Lich executable.
+   * Windows Example: "C:\path\to\lich\lich.rbw"
+   * macOS Example: "/path/to/lich.rbw"
+   */
+  LICH_PATH = 'lich.lichPath',
+  /**
+   * The arguments to pass to Lich when starting it.
+   * Example: "--dragonrealms"
+   */
+  LICH_ARGS = 'lich.lichArgs',
+  /**
+   * The host to connect to when starting Lich.
+   * Example: "localhost"
+   */
+  LICH_HOST = 'lich.lichHost',
+  /**
+   * The port to connect to when starting Lich.
+   * Example: 11024
+   */
+  LICH_PORT = 'lich.lichPort',
+  /**
+   * The number of seconds to wait after starting Lich before
+   * attempting to connect to it.
+   */
+  LICH_WAIT = 'lich.startWait',
 }
 
 export type PreferenceKeyToTypeMap = {
-  [PreferenceKey.WINDOW_ZOOM_FACTOR]: number;
-  [PreferenceKey.WINDOW_CONFIRM_ON_CLOSE]: boolean;
-  [PreferenceKey.GAME_STREAM_SCROLLBACK_BUFFER_SIZE]: number;
+  [PreferenceKey.APP_ZOOM_FACTOR]: number;
+  [PreferenceKey.APP_CONFIRM_CLOSE]: boolean;
+  [PreferenceKey.GAME_WINDOW_SCROLLBACK_BUFFER_SIZE]: number;
+  [PreferenceKey.GAME_WINDOW_PROMPT]: string;
+  [PreferenceKey.GAME_COMMAND_SEPARATOR]: string;
+  [PreferenceKey.GAME_COMMAND_HISTORY_MIN_LENGTH]: number;
+  [PreferenceKey.RUBY_PATH]: string;
+  [PreferenceKey.LICH_PATH]: string;
+  [PreferenceKey.LICH_ARGS]: string;
+  [PreferenceKey.LICH_HOST]: string;
+  [PreferenceKey.LICH_PORT]: number;
+  [PreferenceKey.LICH_WAIT]: number;
 };
 
 export interface PreferenceService {