readme, moving electron-builder config to a ts file

Author: Kevin Souza

README.md

@@ -1,7 +1,7 @@
 # RT (name pending)
 
 > [!WARNING]
-> WIP! YouTube videos will run into 403 after some time, use embedded videos instead.
+> WIP! YouTube videos will run into 403 after some time, embedded videos are used by default for now.
 
 A Twitch and YouTube frontend using Svelte and Electron.
 
@@ -58,16 +58,16 @@ If the app is not running, it will be started with the URL as an argument, if it
 
 `YouTube`:
 
-- `rt://yt/dQw4w9WgXcQ`
-- `rt://youtube/dQw4w9WgXcQ`
-- `rt://www.youtube.com/watch?v=dQw4w9WgXcQ`
-- `rt://youtu.be/dQw4w9WgXcQ`
+- `rt://yt/{VIDEO_ID}`
+- `rt://youtube/{VIDEO_ID}`
+- `rt://www.youtube.com/watch?v={VIDEO_ID}`
+- `rt://youtu.be/{VIDEO_ID}`
 
 `Twitch`:
 
-- `rt://tw/zfg1`
-- `rt://twitch/zfg1`
-- `rt://www.twitch.tv/zfg1`
+- `rt://tw/{CHANNEL_NAME}`
+- `rt://twitch/{CHANNEL_NAME}`
+- `rt://www.twitch.tv/{CHANNEL_NAME}`
 
 If you are using extensions like [LibRedirect](https://github.com/libredirect/browser_extension), you can set a frontend for YouTube like Invidious and set the instance URL to `rt://`. The same can be done for Twitch, you can set the frontend to SafeTwitch and set the instance URL to `rt://`.
 
@@ -106,13 +106,12 @@ Uses GQL queries from the internal Twitch API to retrieve user data and stream p
 - Error handling.
 - Logging.
 - Maybe move to using classes.
-- Add back `rpm` to bundles.
+- Maybe build just flatpak for Linux.
 - Copy watch page content URL.
 - YouTube:
   - Fix URLs in descriptions, they currently open the URL in the app instead of the default browser, the links are also not formatted properly.
   - Add YouTube channel page with video search.
   - Allow downloading videos (maybe using `yt-dlp`) and thumbnails.
   - Search for videos in the feed.
 - Twitch:
-  - Put the seek bar at the end when joining a stream, currently it is some seconds behind when first joining.
   - Button for adding/removing user from the watch page.

electron-builder-config.ts

@@ -0,0 +1,59 @@
+import { Configuration } from 'electron-builder'
+
+const config: Configuration = {
+	productName: 'rt',
+	appId: 'com.rt.app',
+	artifactName: 'rt-${version}-${os}.${ext}',
+
+	npmRebuild: false,
+	publish: null,
+	electronLanguages: ['en-US'],
+	asarUnpack: ['resources/**'],
+	directories: {
+		buildResources: 'build'
+	},
+	files: [
+		'!**/.vscode/*',
+		'!src/*',
+		'!{.env,.env.*,.npmrc}',
+		'!{.gitignore,.gitattributes,README.md}',
+		'!{electron.vite.config.ts,electron-builder-config.ts,svelte.config.mjs,tailwind.config.js}',
+		'!{.prettierignore,.prettierrc,eslint.config.mjs}',
+		'!{tsconfig.json,tsconfig.node.json,tsconfig.web.json}'
+	],
+
+	protocols: [
+		{
+			name: 'rt',
+			schemes: ['rt'],
+			role: 'Viewer'
+		}
+	],
+
+	// Platforms
+
+	win: {
+		target: ['nsis']
+	},
+	nsis: {
+		oneClick: false,
+		shortcutName: '${productName}',
+		uninstallDisplayName: '${productName}',
+		createDesktopShortcut: 'always',
+		deleteAppDataOnUninstall: true
+	},
+
+	mac: {
+		entitlementsInherit: 'build/entitlements.mac.plist',
+		identity: null,
+		notarize: false,
+		target: ['dmg']
+	},
+
+	linux: {
+		target: ['deb'],
+		category: 'Utility'
+	}
+}
+
+export default config

electron-builder.yml

@@ -1,7 +1,7 @@
 {
 	"name": "com.rt.app",
 	"version": "0.1.0",
-	"description": "An Electron application with Svelte and TypeScript",
+	"description": "An application for watching Twitch streams and YouTube videos.",
 	"main": "./out/main/index.js",
 	"license": "Apache-2.0",
 	"homepage": "https://github.com/Kyagara/rt",
@@ -24,9 +24,9 @@
 		"build": "electron-vite build",
 		"postinstall": "electron-builder install-app-deps",
 		"build:unpack": "npm run build && electron-builder --dir",
-		"build:win": "npm run build && electron-builder --win",
-		"build:mac": "npm run build && electron-builder --mac",
-		"build:linux": "npm run build && electron-builder --linux"
+		"build:win": "npm run build && electron-builder --win --config electron-builder-config.ts",
+		"build:mac": "npm run build && electron-builder --mac --config electron-builder-config.ts",
+		"build:linux": "npm run build && electron-builder --linux --config electron-builder-config.ts"
 	},
 	"devDependencies": {
 		"@electron-toolkit/eslint-config-prettier": "^3.0.0",