XSOverlay: Update to new API (#2736)

Co-authored-by: v <vendicated@riseup.net>
This commit is contained in:
Nyako 2024-07-30 17:48:11 -04:00 committed by GitHub
parent 51ae019cd5
commit 902a86c3b2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 94 additions and 46 deletions

View file

@ -1,15 +0,0 @@
# XSOverlay Notifier
Sends Discord messages to [XSOverlay](https://store.steampowered.com/app/1173510/XSOverlay/) for easier viewing while using VR.
## Preview
![](https://github.com/Vendicated/Vencord/assets/24845294/205d2055-bb4a-44e4-b7e3-265391bccd40)
![](https://github.com/Vendicated/Vencord/assets/24845294/f15eff61-2d52-4620-bcab-808ecb1606d2)
## Usage
- Enable this plugin
- Set plugin settings as desired
- Open XSOverlay
- get ping spammed

View file

@ -1,16 +0,0 @@
/*
* Vencord, a Discord client mod
* Copyright (c) 2023 Vendicated and contributors
* SPDX-License-Identifier: GPL-3.0-or-later
*/
import { createSocket, Socket } from "dgram";
let xsoSocket: Socket;
export function sendToOverlay(_, data: any) {
data.icon = Buffer.from(data.icon).toString("base64");
const json = JSON.stringify(data);
xsoSocket ??= createSocket("udp4");
xsoSocket.send(json, 42069, "127.0.0.1");
}

View file

@ -0,0 +1,14 @@
# XSOverlay Notifier
Sends Discord messages to [XSOverlay](https://store.steampowered.com/app/1173510/XSOverlay/) for easier viewing while using VR.
## Preview
![Resulting notification inside XSOverlay](https://github.com/Vendicated/Vencord/assets/24845294/205d2055-bb4a-44e4-b7e3-265391bccd40)
![Test notification inside XSOverlay](https://github.com/user-attachments/assets/d3b0c387-1d67-4697-a470-d4a927e228f4)
## Usage
- Enable this plugin
- Set port and plugin settings as desired (defaults should work fine)
- Open SteamVR and XSOverlay

View file

@ -8,9 +8,9 @@ import { definePluginSettings } from "@api/Settings";
import { makeRange } from "@components/PluginSettings/components"; import { makeRange } from "@components/PluginSettings/components";
import { Devs } from "@utils/constants"; import { Devs } from "@utils/constants";
import { Logger } from "@utils/Logger"; import { Logger } from "@utils/Logger";
import definePlugin, { OptionType, PluginNative, ReporterTestable } from "@utils/types"; import definePlugin, { OptionType, ReporterTestable } from "@utils/types";
import { findByCodeLazy, findLazy } from "@webpack"; import { findByCodeLazy, findLazy } from "@webpack";
import { ChannelStore, GuildStore, UserStore } from "@webpack/common"; import { Button, ChannelStore, GuildStore, UserStore } from "@webpack/common";
import type { Channel, Embed, GuildMember, MessageAttachment, User } from "discord-types/general"; import type { Channel, Embed, GuildMember, MessageAttachment, User } from "discord-types/general";
const ChannelTypes = findLazy(m => m.ANNOUNCEMENT_THREAD === 10); const ChannelTypes = findLazy(m => m.ANNOUNCEMENT_THREAD === 10);
@ -68,10 +68,40 @@ interface Call {
ringing: string[]; ringing: string[];
} }
interface ApiObject {
sender: string,
target: string,
command: string,
jsonData: string,
rawData: string | null,
}
interface NotificationObject {
type: number;
timeout: number;
height: number;
opacity: number;
volume: number;
audioPath: string;
title: string;
content: string;
useBase64Icon: boolean;
icon: ArrayBuffer | string;
sourceApp: string;
}
const notificationsShouldNotify = findByCodeLazy(".SUPPRESS_NOTIFICATIONS))return!1"); const notificationsShouldNotify = findByCodeLazy(".SUPPRESS_NOTIFICATIONS))return!1");
const XSLog = new Logger("XSOverlay"); const logger = new Logger("XSOverlay");
const settings = definePluginSettings({ const settings = definePluginSettings({
webSocketPort: {
type: OptionType.NUMBER,
description: "Websocket port",
default: 42070,
async onChange() {
await start();
}
},
botNotifications: { botNotifications: {
type: OptionType.BOOLEAN, type: OptionType.BOOLEAN,
description: "Allow bot notifications", description: "Allow bot notifications",
@ -136,7 +166,17 @@ const settings = definePluginSettings({
}, },
}); });
const Native = VencordNative.pluginHelpers.XSOverlay as PluginNative<typeof import("./native")>; let socket: WebSocket;
async function start() {
if (socket) socket.close();
socket = new WebSocket(`ws://127.0.0.1:${settings.store.webSocketPort ?? 42070}/?client=Vencord`);
return new Promise((resolve, reject) => {
socket.onopen = resolve;
socket.onerror = reject;
setTimeout(reject, 3000);
});
}
export default definePlugin({ export default definePlugin({
name: "XSOverlay", name: "XSOverlay",
@ -248,7 +288,21 @@ export default definePlugin({
if (shouldIgnoreForChannelType(channel)) return; if (shouldIgnoreForChannelType(channel)) return;
sendMsgNotif(titleString, finalMsg, message); sendMsgNotif(titleString, finalMsg, message);
} }
} },
start,
stop() {
socket.close();
},
settingsAboutComponent: () => (
<>
<Button onClick={() => sendOtherNotif("This is a test notification! explode", "Hello from Vendor!")}>
Send test notification
</Button>
</>
)
}); });
function shouldIgnoreForChannelType(channel: Channel) { function shouldIgnoreForChannelType(channel: Channel) {
@ -259,9 +313,8 @@ function shouldIgnoreForChannelType(channel: Channel) {
function sendMsgNotif(titleString: string, content: string, message: Message) { function sendMsgNotif(titleString: string, content: string, message: Message) {
fetch(`https://cdn.discordapp.com/avatars/${message.author.id}/${message.author.avatar}.png?size=128`).then(response => response.arrayBuffer()).then(result => { fetch(`https://cdn.discordapp.com/avatars/${message.author.id}/${message.author.avatar}.png?size=128`).then(response => response.arrayBuffer()).then(result => {
const msgData = { const msgData: NotificationObject = {
messageType: 1, type: 1,
index: 0,
timeout: settings.store.lengthBasedTimeout ? calculateTimeout(content) : settings.store.timeout, timeout: settings.store.lengthBasedTimeout ? calculateTimeout(content) : settings.store.timeout,
height: calculateHeight(content), height: calculateHeight(content),
opacity: settings.store.opacity, opacity: settings.store.opacity,
@ -270,17 +323,17 @@ function sendMsgNotif(titleString: string, content: string, message: Message) {
title: titleString, title: titleString,
content: content, content: content,
useBase64Icon: true, useBase64Icon: true,
icon: result, icon: new TextDecoder().decode(result),
sourceApp: "Vencord" sourceApp: "Vencord"
}; };
Native.sendToOverlay(msgData);
sendToOverlay(msgData);
}); });
} }
function sendOtherNotif(content: string, titleString: string) { function sendOtherNotif(content: string, titleString: string) {
const msgData = { const msgData: NotificationObject = {
messageType: 1, type: 1,
index: 0,
timeout: settings.store.lengthBasedTimeout ? calculateTimeout(content) : settings.store.timeout, timeout: settings.store.lengthBasedTimeout ? calculateTimeout(content) : settings.store.timeout,
height: calculateHeight(content), height: calculateHeight(content),
opacity: settings.store.opacity, opacity: settings.store.opacity,
@ -289,10 +342,22 @@ function sendOtherNotif(content: string, titleString: string) {
title: titleString, title: titleString,
content: content, content: content,
useBase64Icon: false, useBase64Icon: false,
icon: null, icon: "default",
sourceApp: "Vencord" sourceApp: "Vencord"
}; };
Native.sendToOverlay(msgData); sendToOverlay(msgData);
}
async function sendToOverlay(notif: NotificationObject) {
const apiObject: ApiObject = {
sender: "Vencord",
target: "xsoverlay",
command: "SendNotification",
jsonData: JSON.stringify(notif),
rawData: null
};
if (socket.readyState !== socket.OPEN) await start();
socket.send(JSON.stringify(apiObject));
} }
function shouldNotify(message: Message, channel: string) { function shouldNotify(message: Message, channel: string) {