Add new user message

plugin/new_user_message/new_user_message.py

@@ -0,0 +1,74 @@
+import os
+
+from talon import Context, Module, actions, app, imgui
+
+# we know to stop showing the new user message when the following path is defined
+NEW_USER_MESSAGE_DISMISSAL_PATH = os.path.join(
+    os.path.dirname(__file__), "new_user_message_dismissed"
+)
+
+
+@imgui.open(y=0)
+def new_user_gui(gui: imgui.GUI):
+    gui.text("Welcome to the Talon Community Configuration!")
+    gui.line()
+
+    gui.text("For additional help or to close this:")
+    gui.text(
+        "You may say one of the following commands or click the corresponding button"
+    )
+    gui.text('You can reopen this message by saying: "New User Message"')
+
+    gui.spacer()
+
+    if gui.button("Open Talon Wiki (Open the Talon Wiki)"):
+        actions.user.open_url("https://talon.wiki")
+    if gui.button(
+        "Open Talon Slack (Open a slack channel where you can get help and talk with other talon users)"
+    ):
+        actions.user.open_url("http://talonvoice.slack.com/messages/help")
+    if gui.button(
+        "Open Talon Practice (Open a webpage for helping new users learn how to use Talon)"
+    ):
+        actions.user.open_url("https://chaosparrot.github.io/talon_practice/")
+
+    gui.line()
+
+    if gui.button("Message Hide (Close this message)"):
+        actions.user.new_user_message_hide()
+    if gui.button("Message Dismiss (Close this message and stop seeing it on startup)"):
+        actions.user.new_user_message_stop_showing_on_startup()
+        actions.user.new_user_message_hide()
+
+
+mod = Module()
+mod.tag("new_user_message_showing", desc="The new user message gui is showing")
+
+ctx = Context()
+
+
+def on_ready():
+    if not os.path.exists(NEW_USER_MESSAGE_DISMISSAL_PATH):
+        actions.user.new_user_message_show()
+
+
+app.register("ready", on_ready)
+
+
+@mod.action_class
+class Actions:
+    def new_user_message_show():
+        """Shows a useful gui intended for new users"""
+        new_user_gui.show()
+        ctx.tags = ["user.new_user_message_showing"]
+
+    def new_user_message_hide():
+        """Hides the new user message gui"""
+        new_user_gui.hide()
+        ctx.tags = []
+
+    def new_user_message_stop_showing_on_startup():
+        """Stops showing the new user message gui on startup"""
+        with open(NEW_USER_MESSAGE_DISMISSAL_PATH, "w") as _:
+            # this creates an empty file
+            pass

plugin/new_user_message/new_user_message_global.talon

@@ -0,0 +1,3 @@
+-
+
+new user message [show]: user.new_user_message_show()

plugin/new_user_message/new_user_message_showing.talon

@@ -0,0 +1,8 @@
+tag: user.new_user_message_showing
+-
+
+message hide: user.new_user_message_hide()
+
+message dismiss:
+    user.new_user_message_stop_showing_on_startup()
+    user.new_user_message_hide()