feat(ui): Remove "Options" section

The last remaining option "Observe astro events" is now hosted in the "Science" section.

We might have an "Options" section again at a later time to control the meta behavior of KS. Everything relating to controlling the game should be hosted in a settings section relating to a tab in the game.

packages/userscript/source/Engine.ts

@@ -220,15 +220,8 @@ export class Engine {
   private async _iterate(): Promise<void> {
     const context = { tick: new Date().getTime() };
 
-    const subOptions = this._host.engine.settings.options;
-
     // The order in which these actions are performed is probably
     // semi-intentional and should be preserved or improved.
-
-    // Observe astronomical events.
-    if (subOptions.enabled && subOptions.items.observe.enabled) {
-      this.observeStars();
-    }
     await this.scienceManager.tick(context);
     this.bonfireManager.tick(context);
     this.spaceManager.tick(context);
@@ -240,17 +233,6 @@ export class Engine {
     await this.timeControlManager.tick(context);
   }
 
-  /**
-   * If there is currently an astronomical event, observe it.
-   */
-  observeStars(): void {
-    if (this._host.gamePage.calendar.observeBtn !== null) {
-      this._host.gamePage.calendar.observeHandler();
-      this._host.engine.iactivity("act.observe", [], "ks-star");
-      this._host.engine.storeForSummary("stars", 1);
-    }
-  }
-
   /**
    * Retrieve an internationalized string literal.
    *

packages/userscript/source/ScienceManager.ts

@@ -37,6 +37,11 @@ export class ScienceManager extends UpgradeManager {
     if (this.settings.policies.enabled && this._host.gamePage.tabs[2].visible) {
       await this.autoPolicy();
     }
+
+    // Observe astronomical events.
+    if (this.settings.observe.enabled) {
+      this.observeStars();
+    }
   }
 
   load(settings: ScienceSettings) {
@@ -112,4 +117,15 @@ export class ScienceManager extends UpgradeManager {
       await this.upgrade(item, "policy");
     }
   }
+
+  /**
+   * If there is currently an astronomical event, observe it.
+   */
+  observeStars(): void {
+    if (this._host.gamePage.calendar.observeBtn !== null) {
+      this._host.gamePage.calendar.observeHandler();
+      this._host.engine.iactivity("act.observe", [], "ks-star");
+      this._host.engine.storeForSummary("stars", 1);
+    }
+  }
 }

packages/userscript/source/settings/EngineSettings.ts

@@ -1,5 +1,4 @@
 import { FilterSettings } from "./FilterSettings";
-import { OptionsSettings } from "./OptionsSettings";
 import { ResourcesSettings } from "./ResourcesSettings";
 import { Setting } from "./Settings";
 import { LegacyStorage } from "./SettingsStorage";
@@ -11,18 +10,15 @@ export class EngineSettings extends Setting {
   interval = 2000;
 
   filters: FilterSettings;
-  options: OptionsSettings;
   resources: ResourcesSettings;
 
   constructor(
     enabled = false,
     filters = new FilterSettings(),
-    options = new OptionsSettings(),
     resources = new ResourcesSettings()
   ) {
     super(enabled);
     this.filters = filters;
-    this.options = options;
     this.resources = resources;
   }
 
@@ -31,7 +27,6 @@ export class EngineSettings extends Setting {
     this.interval = settings.interval;
 
     this.filters.load(settings.filters);
-    this.options.load(settings.options);
     this.resources.load(settings.resources);
   }
 
@@ -40,7 +35,6 @@ export class EngineSettings extends Setting {
     subject.toggles.engine = settings.enabled;
 
     FilterSettings.toLegacyOptions(settings.filters, subject);
-    OptionsSettings.toLegacyOptions(settings.options, subject);
     ResourcesSettings.toLegacyOptions(settings.resources, subject);
   }
 
@@ -51,7 +45,6 @@ export class EngineSettings extends Setting {
     options.enabled = subject.toggles.engine ?? options.enabled;
 
     options.filters = FilterSettings.fromLegacyOptions(subject);
-    options.options = OptionsSettings.fromLegacyOptions(subject);
     options.resources = ResourcesSettings.fromLegacyOptions(subject);
 
     return options;

packages/userscript/source/settings/Options.ts

@@ -41,7 +41,7 @@ export class Options {
       time: settings.time.enabled,
       timeCtrl: settings.timeControl.enabled,
       distribute: settings.village.enabled,
-      options: settings.engine.options.enabled,
+      options: true,
       filter: settings.engine.filters.enabled,
     };
 

packages/userscript/source/settings/ScienceSettings.ts

@@ -10,11 +10,18 @@ export type ScienceSettingsItem = TechSettings | PolicySettings;
 export class ScienceSettings extends Setting {
   policies: PolicySettings;
   techs: TechSettings;
-
-  constructor(enabled = false, policies = new PolicySettings(), techs = new TechSettings()) {
+  observe: Setting;
+
+  constructor(
+    enabled = false,
+    policies = new PolicySettings(),
+    techs = new TechSettings(),
+    observe = new Setting(true)
+  ) {
     super(enabled);
     this.policies = policies;
     this.techs = techs;
+    this.observe = observe;
   }
 
   static validateGame(game: GamePage, settings: ScienceSettings) {
@@ -27,13 +34,17 @@ export class ScienceSettings extends Setting {
 
     this.policies.load(settings.policies);
     this.techs.load(settings.techs);
+
+    this.observe.enabled = settings.observe.enabled;
   }
 
   static toLegacyOptions(settings: ScienceSettings, subject: LegacyStorage) {
     subject.toggles.upgrade = settings.enabled;
 
     PolicySettings.toLegacyOptions(settings.policies, subject);
     TechSettings.toLegacyOptions(settings.techs, subject);
+
+    subject.items["toggle-observe"] = settings.observe.enabled;
   }
 
   static fromLegacyOptions(subject: LegacyStorage) {
@@ -43,6 +54,8 @@ export class ScienceSettings extends Setting {
     options.policies = PolicySettings.fromLegacyOptions(subject);
     options.techs = TechSettings.fromLegacyOptions(subject);
 
+    options.observe.enabled = subject.items["toggle-observe"] ?? options.observe.enabled;
+
     return options;
   }
 }

packages/userscript/source/settings/SettingsStorage.ts

@@ -14,7 +14,6 @@ import {
 } from "../types";
 import { BonfireItem } from "./BonfireSettings";
 import { FilterItem } from "./FilterSettings";
-import { OptionsItem } from "./OptionsSettings";
 import { FaithItem, ReligionAdditionItem, UnicornItem } from "./ReligionSettings";
 import { ScienceItem } from "./ScienceSettings";
 import { AllItems } from "./Settings";
@@ -45,7 +44,6 @@ type SetMinResetFaithItem = `set-reset-faith-${FaithItem | UnicornItem}-min`;
 type SetMinResetSpaceItem = `set-reset-space-${SpaceBuildings}-min`;
 type SetMinResetTimeItem = `set-reset-time-${TimeItem}-min`;
 type SetMinResetUnicornItem = `set-reset-unicorn-${UnicornItem}-min`;
-type SetSubtriggerOptionItem = `set-${OptionsItem}-trigger`;
 type SetSubtriggerReligionItem = `set-${ReligionAdditionItem}-trigger`;
 type SetSubtriggerTimeCtrlItem = `set-${"accelerateTime" | "timeSkip"}-trigger`;
 type ToggleBuildEmbassies = "toggle-buildEmbassies";
@@ -62,7 +60,7 @@ type ToggleLimitedJobItem = `toggle-limited-${Job}`;
 type ToggleLimitedRaceItem = `toggle-limited-${Race}`;
 type ToggleLimitedResourceItem = `toggle-limited-${Resource}`;
 type ToggleMissionItem = `toggle-mission-${Missions}`;
-type ToggleOptionsItem = `toggle-${OptionsItem}`;
+type ToggleObserve = `toggle-observe`;
 type TogglePolicyItem = `toggle-policy-${Policy}`;
 type TogglePromoteLeader = `toggle-promote`;
 type ToggleRaceItem = `toggle-${Race}`;
@@ -105,7 +103,6 @@ export type LegacyStorage = {
     Partial<Record<SetMinResetSpaceItem, number>> &
     Partial<Record<SetMinResetTimeItem, number>> &
     Partial<Record<SetMinResetUnicornItem, number>> &
-    Partial<Record<SetSubtriggerOptionItem, number>> &
     Partial<Record<SetSubtriggerReligionItem, number>> &
     Partial<Record<SetSubtriggerTimeCtrlItem, number>> &
     Partial<Record<ToggleBuildEmbassies, boolean>> &
@@ -122,7 +119,7 @@ export type LegacyStorage = {
     Partial<Record<ToggleLimitedRaceItem, boolean>> &
     Partial<Record<ToggleLimitedResourceItem, boolean>> &
     Partial<Record<ToggleMissionItem, boolean>> &
-    Partial<Record<ToggleOptionsItem, boolean>> &
+    Partial<Record<ToggleObserve, boolean>> &
     Partial<Record<TogglePolicyItem, boolean>> &
     Partial<Record<TogglePromoteLeader, boolean>> &
     Partial<Record<ToggleRaceItem, boolean>> &

packages/userscript/source/ui/ScienceSettingsUi.ts

@@ -9,6 +9,7 @@ export class ScienceSettingsUi extends SettingsSectionUi<ScienceSettings> {
   private readonly _items: Array<SettingListItem>;
   private readonly _policiesUi: PolicySettingsUi;
   private readonly _techsUi: TechSettingsUi;
+  protected readonly _observeStars: SettingListItem;
 
   constructor(host: UserScript, settings: ScienceSettings) {
     super(host, host.engine.i18n("ui.upgrade"), settings);
@@ -29,8 +30,25 @@ export class ScienceSettingsUi extends SettingsSectionUi<ScienceSettings> {
     this._policiesUi = new PolicySettingsUi(this._host, this.setting.policies);
     this._techsUi = new TechSettingsUi(this._host, this.setting.techs);
 
-    this._items = [this._policiesUi, this._techsUi];
+    this._observeStars = new SettingListItem(
+      this._host,
+      this._host.engine.i18n("option.observe"),
+      this.setting.observe,
+      {
+        onCheck: () =>
+          this._host.engine.imessage("status.sub.enable", [
+            this._host.engine.i18n("option.observe"),
+          ]),
+        onUnCheck: () =>
+          this._host.engine.imessage("status.sub.disable", [
+            this._host.engine.i18n("option.observe"),
+          ]),
+      }
+    );
+    this.addChild(this._observeStars);
 
-    this.addChildren([this._techsUi, this._policiesUi]);
+    this._items = [this._policiesUi, this._techsUi, this._observeStars];
+
+    this.addChildren([this._techsUi, this._policiesUi, this._observeStars]);
   }
 }

packages/userscript/source/ui/UserInterface.ts

@@ -4,7 +4,6 @@ import { UserScript } from "../UserScript";
 import { BonfireSettingsUi } from "./BonfireSettingsUi";
 import { EngineSettingsUi } from "./EngineSettingsUi";
 import { FiltersSettingsUi } from "./FilterSettingsUi";
-import { OptionsSettingsUi } from "./OptionsSettingsUi";
 import { ReligionSettingsUi } from "./ReligionSettingsUi";
 import { ResourcesSettingsUi } from "./ResourcesSettingsUi";
 import { ScienceSettingsUi } from "./ScienceSettingsUi";
@@ -29,7 +28,6 @@ export class UserInterface {
   private _timeUi: TimeSettingsUi;
   private _timeCtrlUi: TimeControlSettingsUi;
   private _distributeUi: VillageSettingsUi;
-  private _optionsUi: OptionsSettingsUi;
   private _filterUi: FiltersSettingsUi;
 
   constructor(host: UserScript) {
@@ -47,7 +45,6 @@ export class UserInterface {
     this._timeUi = new TimeSettingsUi(this._host, engine.timeManager.settings);
     this._timeCtrlUi = new TimeControlSettingsUi(this._host, engine.timeControlManager.settings);
     this._distributeUi = new VillageSettingsUi(this._host, engine.villageManager.settings);
-    this._optionsUi = new OptionsSettingsUi(this._host, engine.settings.options);
     this._filterUi = new FiltersSettingsUi(this._host, engine.settings.filters);
   }
 
@@ -75,7 +72,6 @@ export class UserInterface {
     optionsListElement.append(this._spaceUi.element);
     optionsListElement.append(this._timeUi.element);
     optionsListElement.append(this._timeCtrlUi.element);
-    optionsListElement.append(this._optionsUi.element);
     optionsListElement.append(this._filterUi.element);
 
     // Make _engineUI's expando button hide/show the other option groups
@@ -99,7 +95,6 @@ export class UserInterface {
       this._timeUi.toggle(sectionsVisible);
       this._timeCtrlUi.toggle(sectionsVisible);
       this._distributeUi.toggle(sectionsVisible);
-      this._optionsUi.toggle(sectionsVisible);
       this._filterUi.toggle(sectionsVisible);
     });
 
@@ -144,7 +139,6 @@ export class UserInterface {
     this._timeUi.refreshUi();
     this._timeCtrlUi.refreshUi();
     this._distributeUi.refreshUi();
-    this._optionsUi.refreshUi();
     this._filterUi.refreshUi();
   }