Add support dialog (#1221)

gentlegiantJGC · web-flow · commit 684eeb45b35c · 2025-12-05T14:39:14.000Z
* Add support dialog

* Fix variable used before defined

* Add support button to the home page

* Reformat
diff --git a/amulet_map_editor/api/framework/app.py b/amulet_map_editor/api/framework/app.py
@@ -3,10 +3,12 @@
 import sys
 import locale
 import logging
+import time
 
 from amulet_map_editor.api import config
 from amulet_map_editor import __version__
 from .warning_dialog import WarningDialog
+from .support_dialog import SupportDialog
 
 log = logging.getLogger(__name__)
 
@@ -27,6 +29,18 @@ def OnInit(self):
         self._amulet_ui.Show()
 
         meta_config = config.get("amulet_meta", {})
+
+        support_dialog_show_time = meta_config.get("support_dialog_show_time", 0)
+        if support_dialog_show_time < time.time() - 3600 * 24 * 7:
+            # Last shown more than a week ago
+            support_dialog = SupportDialog(
+                self._amulet_ui, 60, support_dialog_show_time == 0
+            )
+            support_dialog.Centre()
+            if support_dialog.ShowModal() == wx.ID_OK:
+                meta_config["support_dialog_show_time"] = time.time()
+                config.put("amulet_meta", meta_config)
+
         if not meta_config.get("do_not_show_warning_dialog", False):
             warning_dialog = WarningDialog(self._amulet_ui)
             warning_dialog.Centre()
diff --git a/amulet_map_editor/api/framework/pages/main_menu.py b/amulet_map_editor/api/framework/pages/main_menu.py
@@ -8,6 +8,7 @@
 
 from amulet_map_editor.api import image, lang
 from .base_page import BasePageUI
+from ..support_dialog import SupportDialog
 from amulet_map_editor.api.wx.ui.select_world import open_level_from_dialog
 
 
@@ -49,6 +50,11 @@ def __init__(self, parent: wx.Window):
         )
         sizer.Add(self._open_world_button, 0, wx.ALL | wx.CENTER, 5)
 
+        self._support_button = wx.Button(self, size=(400, 70))
+        self._support_button.SetFont(button_font)
+        self._support_button.Bind(wx.EVT_BUTTON, self._support)
+        sizer.Add(self._support_button, 0, wx.ALL | wx.CENTER, 5)
+
         self._user_manual_button = wx.Button(self, size=(400, 70))
         self._user_manual_button.SetFont(button_font)
         self._user_manual_button.Bind(wx.EVT_BUTTON, self._documentation)
@@ -109,6 +115,7 @@ def __init__(self, parent: wx.Window):
     def _load_strings(self):
         self._amulet_name.SetLabel(lang.get("meta.amulet"))
         self._open_world_button.SetLabel(lang.get("main_menu.open_world"))
+        self._support_button.SetLabel(lang.get("main_menu.support"))
         self._user_manual_button.SetLabel(lang.get("main_menu.user_manual"))
         self._user_manual_button.SetToolTip(lang.get("app.browser_open_tooltip"))
         self._bug_tracker_button.SetLabel(lang.get("main_menu.bug_tracker"))
@@ -118,6 +125,11 @@ def _load_strings(self):
         self._sponsor_label.SetLabel(lang.get("main_menu.our_sponsors"))
         self._sponsor_link.SetLabel(lang.get("main_menu.sponsor_link"))
 
+    def _support(self, _):
+        support_dialog = SupportDialog(self, 0, False)
+        support_dialog.Centre()
+        support_dialog.ShowModal()
+
     @staticmethod
     def _documentation(_):
         webbrowser.open(
diff --git a/amulet_map_editor/api/framework/support_dialog.py b/amulet_map_editor/api/framework/support_dialog.py
@@ -0,0 +1,142 @@
+import wx
+import wx.lib.agw.hyperlink
+
+from amulet_map_editor import lang
+
+
+class SupportDialog(wx.Dialog):
+    def __init__(self, parent: wx.Window, wait_time: int, is_first: bool):
+        super().__init__(parent, style=wx.CAPTION)
+        self.SetTitle(lang.get("support_dialog.title"))
+
+        self._wait_time = wait_time
+
+        main_sizer = wx.BoxSizer(wx.VERTICAL)
+
+        title = wx.StaticText(
+            self,
+            wx.ID_ANY,
+            lang.get("support_dialog.title"),
+            style=wx.ALIGN_CENTER_HORIZONTAL,
+        )
+        font = title.GetFont()
+        font.SetPointSize(50)
+        title.SetFont(font)
+        main_sizer.Add(title, 0, wx.ALL | wx.EXPAND, 5)
+
+        content_1 = wx.StaticText(
+            self,
+            wx.ID_ANY,
+            lang.get("support_dialog.content_1"),
+            style=wx.ALIGN_CENTER_HORIZONTAL,
+        )
+        font = content_1.GetFont()
+        font.SetPointSize(12)
+        content_1.SetFont(font)
+        content_1.Wrap(750)
+        main_sizer.Add(content_1, 0, wx.EXPAND)
+
+        main_sizer.AddSpacer(20)
+
+        content_2 = wx.StaticText(
+            self,
+            wx.ID_ANY,
+            lang.get("support_dialog.content_2"),
+            style=wx.ALIGN_CENTER_HORIZONTAL,
+        )
+        font = content_2.GetFont()
+        font.SetPointSize(12)
+        content_2.SetFont(font)
+        content_2.Wrap(750)
+        main_sizer.Add(content_2, 0, wx.EXPAND)
+
+        main_sizer.AddSpacer(20)
+
+        github_sponsor_link = wx.lib.agw.hyperlink.HyperLinkCtrl(
+            self,
+            wx.ID_ANY,
+            lang.get("support_dialog.github_sponsor"),
+            URL="https://github.com/sponsors/Amulet-Team",
+        )
+        font = github_sponsor_link.GetFont()
+        font.SetPointSize(12)
+        github_sponsor_link.SetFont(font)
+        main_sizer.Add(github_sponsor_link, 0, wx.ALIGN_CENTER)
+
+        main_sizer.AddSpacer(10)
+
+        paypal_sponsor_link = wx.lib.agw.hyperlink.HyperLinkCtrl(
+            self,
+            wx.ID_ANY,
+            lang.get("support_dialog.paypal_sponsor"),
+            URL="https://www.paypal.com/donate/?hosted_button_id=6G7P8K36W7TX2",
+        )
+        font = paypal_sponsor_link.GetFont()
+        font.SetPointSize(12)
+        paypal_sponsor_link.SetFont(font)
+        main_sizer.Add(paypal_sponsor_link, 0, wx.ALIGN_CENTER)
+
+        main_sizer.AddSpacer(20)
+
+        content_3 = wx.StaticText(
+            self,
+            wx.ID_ANY,
+            lang.get("support_dialog.content_3"),
+            style=wx.ALIGN_CENTER_HORIZONTAL,
+        )
+        font = content_3.GetFont()
+        font.SetPointSize(12)
+        content_3.SetFont(font)
+        content_3.Wrap(750)
+        main_sizer.Add(content_3, 0, wx.EXPAND)
+
+        main_sizer.AddSpacer(10)
+
+        button_sizer = wx.StdDialogButtonSizer()
+        main_sizer.Add(button_sizer, 0, wx.ALIGN_RIGHT | wx.ALL, 4)
+
+        self._ignore_button = wx.Button(self, wx.ID_CANCEL)
+        self._ignore_button.SetDefault()
+        self.SetEscapeId(self._ignore_button.GetId())
+        button_sizer.Add(self._ignore_button)
+
+        self._support_button = wx.Button(
+            self, wx.ID_OK, lang.get("support_dialog.support_button")
+        )
+        if is_first:
+            self._support_button.Disable()
+        button_sizer.Add(self._support_button)
+        self.SetAffirmativeId(self._support_button.GetId())
+
+        self._set_ignore_text()
+
+        button_sizer.Realize()
+
+        self.SetSizer(main_sizer)
+        main_sizer.Fit(self)
+
+        self._timer = wx.Timer(self)
+        if 0 < self._wait_time:
+            self.Bind(wx.EVT_TIMER, self._on_timer, self._timer)
+            self._timer.Start(1000)
+
+        self.Layout()
+
+    def _set_ignore_text(self) -> None:
+        if 0 < self._wait_time:
+            self._ignore_button.Disable()
+            self._ignore_button.SetLabel(
+                lang.get("support_dialog.ignore_button_wait").format(t=self._wait_time)
+            )
+        else:
+            self._support_button.Enable()
+            self._ignore_button.Enable()
+            self._ignore_button.SetLabel(lang.get("support_dialog.ignore_button"))
+        self.Layout()
+
+    def _on_timer(self, evt) -> None:
+        if 0 < self._wait_time:
+            self._wait_time -= 1
+        if self._wait_time <= 0:
+            self._timer.Stop()
+        self._set_ignore_text()
diff --git a/amulet_map_editor/lang/en.lang b/amulet_map_editor/lang/en.lang
@@ -83,17 +83,29 @@ menu_bar.help.menu_name=&Help
 ## The start screen
 main_menu.tab_name=Main Menu
 main_menu.open_world=Open World
+main_menu.support=Support Amulet
 main_menu.user_manual=User Manual
 main_menu.bug_tracker=Bug Tracker
 main_menu.discord=Amulet Discord
 main_menu.our_sponsors=Our Sponsors
-main_menu.sponsor_link=(Sponsor us to get your name here)
+main_menu.sponsor_link=(Click here to support us on Github and get your name here)
 
 # Language Select
 language_select.title=Language Select
 language_select.help=Select the language to use in Amulet from the list below.
 language_select.contribute=If you want to fix or add translations click here.
 
+# Support Dialog
+support_dialog.title=I Need Your Support!
+support_dialog.support_button=I am contributing to Amulet.
+support_dialog.ignore_button_wait=Continue without contributing. Wait {t} seconds
+support_dialog.ignore_button=Continue without contributing.
+support_dialog.content_1=Pathway Studios have been funding the development of Amulet for the past 6 years but have decided to stop funding development from 2026.
+support_dialog.content_2=Who am I?\nI am James. You may know me as gentlegiantJGC.\nAmulet has been my job since 2019 but to continue I need financial support.\nAny contribution, no matter how small, is greatly appreciated.\nWithout your support, development and maintenance of Amulet will stop and Amulet will not be able to open worlds from new versions.
+support_dialog.github_sponsor=Support Amulet on Github
+support_dialog.paypal_sponsor=Support Amulet on Paypal
+support_dialog.content_3=The future of Amulet\nFor the past two years I have been rewriting Amulet from the ground up.\nMost of the libraries are now written in C++ for improved speed and parallelisation and the new application uses Qt to allow more control over the user interface.\nI still have a way to go until the rewrite can replace this version of Amulet but experimental versions of the rewrite should be out soon.
+
 # Warning Dialog
 warning_dialog.title=Welcome to Amulet
 warning_dialog.content=Hello and welcome to Amulet.\n\nWe suggest creating backups of your worlds before opening them in Amulet.\n\nWe try to make sure that Amulet does not corrupt worlds but the save format is undocumented and constantly changing and sometimes we just get things wrong.\n\nFor these reasons we only officially support full releases we have tested against.\nJava snapshots, Bedrock betas and experimental features may work but are untested so not officially supported.\n\nCurrently entities are not supported and items are only supported within the same platform.\nIf you find a feature you want added or a bug that needs fixing report it on our bug tracker.\nPlease use the search tool to see if it has been reported before creating a new ticket.\n\nIf you are new we suggest reading the user manual to familiarise yourself with the program.\n\n- The Amulet Team
