feat: notify about notification feature

Author: feildmaster

changelog.md

@@ -1,5 +1,8 @@
 # UnderScript Changelog
 
+## Version 0.60.3 (2025-03-17)
+1. Due to popular demand, you are now prompted to keep `@underscript`
+
 ## Version 0.60.2 (2025-03-16)
 1. Fixed quest progress noification (probably)
 

src/base/chat/notify.new.js

@@ -3,6 +3,8 @@ import * as settings from '../../utils/settings/index.js';
 import { global, globalSet } from '../../utils/global.js';
 import pendingIgnore from '../../utils/pendingIgnore.js';
 import pingRegex from '../../utils/pingRegex.js';
+import { pingExtras } from './toast.js';
+import { infoToast } from '../../utils/2.toasts.js';
 
 const setting = settings.register({
   name: 'Disable Chat Ping <span style="color: yellow;">(highlighting)</span>',
@@ -13,11 +15,16 @@ const setting = settings.register({
 const mask = '<span style="color: yellow;">$1</span>';
 
 let disabled = false;
+let notified = false;
 
 eventManager.on('preChat:getHistory Chat:getHistory', function enable(data) {
   if (disabled || global('soundsEnabled')) {
-    globalSet('soundsEnabled', this.event === 'Chat:getHistory');
+    if (disabled === false) {
+      globalSet('soundsEnabled', this.event === 'Chat:getHistory');
+    }
     disabled = !disabled;
+  } else {
+    disabled = 'history';
   }
 });
 
@@ -31,6 +38,7 @@ eventManager.on('ChatDetected', () => {
         if (global('soundsEnabled') && original === text) {
           (new Audio('sounds/highlight.wav')).play();
         }
+        notify();
         return regex.replace(text, mask);
       }
 
@@ -39,3 +47,41 @@ eventManager.on('ChatDetected', () => {
     return original;
   });
 });
+
+function notify() {
+  if (disabled || notified) return;
+  notified = true;
+  const words = pingExtras.value();
+  if (!words.includes('@underscript')) return;
+  infoToast({
+    text: 'UnderScript has custom notifications! You can change them however you like.',
+    buttons: [{
+      text: 'Open settings',
+      className: 'dismiss',
+      onclick() {
+        pingExtras.show(true);
+      },
+    }, {
+      text: 'Remove @underscript!',
+      className: 'dismiss',
+      onclick() {
+        pingExtras.set(words.filter((word) => word !== '@underscript'));
+      },
+    }, {
+      text: 'Dismiss',
+      className: 'dismiss',
+    }],
+    className: 'dismissable',
+    css: {
+      button: {
+        border: '',
+        height: '',
+        background: '',
+        'font-size': '',
+        margin: '',
+        'border-radius': '',
+        'white-space': 'normal',
+      },
+    },
+  }, 'underscript.alert.ping');
+}

src/base/chat/toast.js

@@ -22,7 +22,7 @@ export const globalPing = settings.register({
   page: 'Chat',
 });
 
-settings.register({
+export const pingExtras = settings.register({
   name: 'On',
   key: 'underscript.ping.extras',
   type: 'array',

src/base/styles/toast.js

@@ -1,8 +1,26 @@
+import css from '../../utils/css.js';
 import style from '../../utils/style.js';
 
-style.add(
-  '#AlertToast { height: 0; }',
-  '#AlertToast .dismissable > span { display: block; text-align: center; }',
-  '#AlertToast .dismissable .dismiss { width: 160px; text-transform: capitalize; display: block; font-family: DTM-Mono; border: 1px solid #fff; font-size: 14px; margin: 5px auto; background-color: transparent; }',
-  '#AlertToast .dismissable .dismiss:hover { opacity: 0.6; }',
-);
+style.add(css`
+  #AlertToast {
+    height: 0;
+  }
+  #AlertToast .dismissable > span {
+    display: block;
+    text-align: center;
+  }
+  #AlertToast .dismissable .dismiss {
+    background-color: transparent;
+    border: 1px solid #fff;
+    display: block;
+    font-family: DTM-Mono;
+    font-size: 14px;
+    margin: 5px auto;
+    max-width: 80%;
+    min-width: 160px;
+    text-transform: capitalize;
+  }
+  #AlertToast .dismissable .dismiss:hover {
+    opacity: 0.6;
+  }
+`);

src/utils/2.toasts.js

@@ -49,7 +49,7 @@ export function errorToast(error) {
   return toast(lToast);
 }
 
-export function infoToast(arg, key, val) {
+export function infoToast(arg, key, val = '1') {
   if (localStorage.getItem(key) === val) return null;
   if (typeof arg === 'string') {
     arg = {