Compare commits

...

6 Commits

29 changed files with 7726 additions and 9 deletions

41
.gitignore vendored Normal file
View File

@@ -0,0 +1,41 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions
# testing
/coverage
# next.js
/.next/
/out/
# production
/build
# misc
.DS_Store
*.pem
# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*
# env files (can opt-in for committing if needed)
.env*
# vercel
.vercel
# typescript
*.tsbuildinfo
next-env.d.ts

View File

@@ -24,6 +24,8 @@ OpenChat Overlay is a lightweight, open-source Twitch chat overlay solution desi
TWITCH_CLIENT_ID=... TWITCH_CLIENT_ID=...
TWITCH_CLIENT_SECRET=... TWITCH_CLIENT_SECRET=...
``` ```
> **Note:** `TWITCH_CLIENT_ID` and `TWITCH_CLIENT_SECRET` are required for both User Authentication (NextAuth) and the Support Module (Stream Status).
4. Run the development server: 4. Run the development server:
```bash ```bash
npm run dev npm run dev
@@ -33,6 +35,25 @@ OpenChat Overlay is a lightweight, open-source Twitch chat overlay solution desi
- The application uses **Next.js App Router**. - The application uses **Next.js App Router**.
- **Dashboard:** Located in `src/app/(dashboard)`. Protected by authentication. - **Dashboard:** Located in `src/app/(dashboard)`. Protected by authentication.
- **Overlay:** Located in `src/app/overlay/[token]`. Publicly accessible but requires a valid token. Renders with a transparent background. - **Overlay:** Located in `src/app/overlay/[token]`. Publicly accessible but requires a valid token. Renders with a transparent background.
- **API:**
- `/api/auth/*`: Handles user login via Twitch.
- `/api/twitch/status`: Public endpoint to check if the developer (`ramforth`) is live, used by the dashboard support module.
## Features
- **Style Creator:** Customise font, size, colors, opacity, and toggle badges/emotes.
- **Resolution Support:** Toggle between 720p and 1080p base resolutions.
- **Live Preview:** Real-time visual feedback of chat settings.
- **Support Module:** Sidebar widget showing developer status and social links.
## Deployment ## Deployment
(To be added: Instructions for building the Docker image and deploying to an LXC container.)
### Infrastructure Overview
- **Development:** Conducted on local desktop (CachyOS).
- **Version Control:** Synced to `gitea.ramforth.net` under the `RamTech` organization.
- **Production Host:** Standalone Proxmox LXC container or VM.
- **Service URL:** Production will NOT be hosted on `localhost`. All external callbacks (Twitch Auth) must point to the production domain/IP.
### Deployment Workflow
1. Push changes from local development machine to Gitea.
2. Pull changes on the production LXC/VM.
3. Build and run using Docker or as a systemd service.

30
PLAN.md
View File

@@ -11,7 +11,7 @@ To build "OpenChat Overlay"—a free, open-source alternative to StreamElements,
## Architecture ## Architecture
### Next.js Folder Structure (Proposed) ### Next.js Folder Structure
``` ```
src/ src/
├── app/ ├── app/
@@ -25,8 +25,10 @@ src/
│ ├── api/ # API Routes │ ├── api/ # API Routes
│ │ ├── auth/ # NextAuth handlers │ │ ├── auth/ # NextAuth handlers
│ │ │ └── [...nextauth]/route.ts │ │ │ └── [...nextauth]/route.ts
│ │ ── overlay/ # Overlay configuration endpoints │ │ ── overlay/ # Overlay configuration endpoints
│ │ └── [token]/route.ts │ │ └── [token]/route.ts
│ │ └── twitch/ # Twitch API proxy
│ │ └── status/ # Check stream status
│ ├── overlay/ # The public overlay view │ ├── overlay/ # The public overlay view
│ │ └── [token]/ # Dynamic route for user overlay │ │ └── [token]/ # Dynamic route for user overlay
│ │ ├── layout.tsx # Transparent background layout │ │ ├── layout.tsx # Transparent background layout
@@ -35,13 +37,15 @@ src/
├── components/ ├── components/
│ ├── dashboard/ # Dashboard-specific components │ ├── dashboard/ # Dashboard-specific components
│ │ ├── PreviewFrame.tsx # Live preview iframe/component │ │ ├── PreviewFrame.tsx # Live preview iframe/component
│ │ ── StyleControls.tsx # Form for editing styles │ │ ── StyleControls.tsx # Form for editing styles
│ │ └── SupportModule.tsx # Sidebar support & social module
│ ├── overlay/ # Overlay-specific components │ ├── overlay/ # Overlay-specific components
│ │ ├── ChatContainer.tsx │ │ ├── ChatContainer.tsx
│ │ └── Message.tsx │ │ └── Message.tsx
│ └── ui/ # Reusable UI components (buttons, inputs) │ └── ui/ # Reusable UI components (buttons, inputs)
├── lib/ ├── lib/
│ ├── supabase.ts # Supabase client │ ├── supabase.ts # Supabase client
│ ├── twitch.ts # Twitch API helpers
│ ├── utils.ts # Helper functions │ ├── utils.ts # Helper functions
│ └── types.ts # TypeScript interfaces │ └── types.ts # TypeScript interfaces
└── hooks/ # Custom React hooks (useChat, useSettings) └── hooks/ # Custom React hooks (useChat, useSettings)
@@ -55,7 +59,11 @@ src/
### 2. The "Style Creator" ### 2. The "Style Creator"
- **Left Panel:** Controls for font family, size, colors, opacity, badge toggles, and 7TV/BTTV emote toggles. - **Left Panel:** Controls for font family, size, colors, opacity, badge toggles, and 7TV/BTTV emote toggles.
- **Enhanced Settings:**
- Resolution Selection (720p/1080p).
- Quick "Copy Overlay URL" button.
- **Right Panel:** Live preview component rendering mock chat messages with the current settings applied. - **Right Panel:** Live preview component rendering mock chat messages with the current settings applied.
- **Support Module:** Sidebar widget showing developer's live status (via Twitch API) and social/donation links.
- **State:** React state manages unsaved changes; "Save" pushes to Supabase. - **State:** React state manages unsaved changes; "Save" pushes to Supabase.
### 3. The "Secret Sauce" URL (`/overlay/[token]`) ### 3. The "Secret Sauce" URL (`/overlay/[token]`)
@@ -71,11 +79,18 @@ src/
- **Library:** `tmi.js` (client-side execution). - **Library:** `tmi.js` (client-side execution).
- **Cost:** Zero server-side WebSocket processing. - **Cost:** Zero server-side WebSocket processing.
## Hosting & Infrastructure
- **Target:** Proxmox LXC or VM (standalone).
- **Architecture:** Client-side processing via `tmi.js` to ensure the server handles only authentication and configuration serving.
- **Cost Efficiency:** Designed for "near-zero" server overhead to allow hosting on minimal hardware resources.
- **Environment:** The development machine is exclusively for coding; the service will never be hosted on the dev machine.
## Implementation Phases ## Implementation Phases
1. **Project Initialization:** Scaffolding Next.js, Tailwind, and Supabase client. 1. **Project Initialization:** Scaffolding Next.js, Tailwind, and Supabase client. [Completed]
2. **Authentication:** Implementing NextAuth with Twitch. 2. **Authentication:** Implementing NextAuth with Twitch. [In Progress]
3. **Database:** Designing the Schema and connecting Supabase. 3. **Database:** Designing the Schema and connecting Supabase.
4. **Dashboard UI:** Building the Style Creator and Preview. 4. **Dashboard UI:** Building the Style Creator and Preview. [Completed]
- *Added:* Support Module, Resolution settings, Copy Link.
5. **Overlay Logic:** Creating the standalone overlay page and chat connection. 5. **Overlay Logic:** Creating the standalone overlay page and chat connection.
6. **Deployment:** Docker/LXC containerization. 6. **Deployment:** Docker/LXC containerization.
@@ -91,6 +106,7 @@ src/
"backgroundColor": "#000000", "backgroundColor": "#000000",
"backgroundOpacity": 0.5, "backgroundOpacity": 0.5,
"showBadges": true, "showBadges": true,
"resolution": "1080p",
"emotes": { "emotes": {
"bttv": true, "bttv": true,
"seventv": true "seventv": true

36
README.md Normal file
View File

@@ -0,0 +1,36 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

18
eslint.config.mjs Normal file
View File

@@ -0,0 +1,18 @@
import { defineConfig, globalIgnores } from "eslint/config";
import nextVitals from "eslint-config-next/core-web-vitals";
import nextTs from "eslint-config-next/typescript";
const eslintConfig = defineConfig([
...nextVitals,
...nextTs,
// Override default ignores of eslint-config-next.
globalIgnores([
// Default ignores of eslint-config-next:
".next/**",
"out/**",
"build/**",
"next-env.d.ts",
]),
]);
export default eslintConfig;

8
next.config.ts Normal file
View File

@@ -0,0 +1,8 @@
import type { NextConfig } from "next";
const nextConfig: NextConfig = {
/* config options here */
reactCompiler: true,
};
export default nextConfig;

6733
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

30
package.json Normal file
View File

@@ -0,0 +1,30 @@
{
"name": "open-chat-overlay",
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "eslint"
},
"dependencies": {
"clsx": "^2.1.1",
"next": "16.1.1",
"next-auth": "^4.24.13",
"react": "19.2.3",
"react-dom": "19.2.3",
"tailwind-merge": "^3.4.0"
},
"devDependencies": {
"@tailwindcss/postcss": "^4",
"@types/node": "^20",
"@types/react": "^19",
"@types/react-dom": "^19",
"babel-plugin-react-compiler": "1.0.0",
"eslint": "^9",
"eslint-config-next": "16.1.1",
"tailwindcss": "^4",
"typescript": "^5"
}
}

7
postcss.config.mjs Normal file
View File

@@ -0,0 +1,7 @@
const config = {
plugins: {
"@tailwindcss/postcss": {},
},
};
export default config;

1
public/file.svg Normal file
View File

@@ -0,0 +1 @@
<svg fill="none" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><path d="M14.5 13.5V5.41a1 1 0 0 0-.3-.7L9.8.29A1 1 0 0 0 9.08 0H1.5v13.5A2.5 2.5 0 0 0 4 16h8a2.5 2.5 0 0 0 2.5-2.5m-1.5 0v-7H8v-5H3v12a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1M9.5 5V2.12L12.38 5zM5.13 5h-.62v1.25h2.12V5zm-.62 3h7.12v1.25H4.5zm.62 3h-.62v1.25h7.12V11z" clip-rule="evenodd" fill="#666" fill-rule="evenodd"/></svg>

After

Width:  |  Height:  |  Size: 391 B

1
public/globe.svg Normal file
View File

@@ -0,0 +1 @@
<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><g clip-path="url(#a)"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.27 14.1a6.5 6.5 0 0 0 3.67-3.45q-1.24.21-2.7.34-.31 1.83-.97 3.1M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16m.48-1.52a7 7 0 0 1-.96 0H7.5a4 4 0 0 1-.84-1.32q-.38-.89-.63-2.08a40 40 0 0 0 3.92 0q-.25 1.2-.63 2.08a4 4 0 0 1-.84 1.31zm2.94-4.76q1.66-.15 2.95-.43a7 7 0 0 0 0-2.58q-1.3-.27-2.95-.43a18 18 0 0 1 0 3.44m-1.27-3.54a17 17 0 0 1 0 3.64 39 39 0 0 1-4.3 0 17 17 0 0 1 0-3.64 39 39 0 0 1 4.3 0m1.1-1.17q1.45.13 2.69.34a6.5 6.5 0 0 0-3.67-3.44q.65 1.26.98 3.1M8.48 1.5l.01.02q.41.37.84 1.31.38.89.63 2.08a40 40 0 0 0-3.92 0q.25-1.2.63-2.08a4 4 0 0 1 .85-1.32 7 7 0 0 1 .96 0m-2.75.4a6.5 6.5 0 0 0-3.67 3.44 29 29 0 0 1 2.7-.34q.31-1.83.97-3.1M4.58 6.28q-1.66.16-2.95.43a7 7 0 0 0 0 2.58q1.3.27 2.95.43a18 18 0 0 1 0-3.44m.17 4.71q-1.45-.12-2.69-.34a6.5 6.5 0 0 0 3.67 3.44q-.65-1.27-.98-3.1" fill="#666"/></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h16v16H0z"/></clipPath></defs></svg>

After

Width:  |  Height:  |  Size: 1.0 KiB

1
public/next.svg Normal file
View File

@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

After

Width:  |  Height:  |  Size: 1.3 KiB

1
public/vercel.svg Normal file
View File

@@ -0,0 +1 @@
<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1155 1000"><path d="m577.3 0 577.4 1000H0z" fill="#fff"/></svg>

After

Width:  |  Height:  |  Size: 128 B

1
public/window.svg Normal file
View File

@@ -0,0 +1 @@
<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M1.5 2.5h13v10a1 1 0 0 1-1 1h-11a1 1 0 0 1-1-1zM0 1h16v11.5a2.5 2.5 0 0 1-2.5 2.5h-11A2.5 2.5 0 0 1 0 12.5zm3.75 4.5a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5M7 4.75a.75.75 0 1 1-1.5 0 .75.75 0 0 1 1.5 0m1.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5" fill="#666"/></svg>

After

Width:  |  Height:  |  Size: 385 B

View File

@@ -0,0 +1,29 @@
import NextAuth from "next-auth"
import TwitchProvider from "next-auth/providers/twitch"
const handler = NextAuth({
providers: [
TwitchProvider({
clientId: process.env.TWITCH_CLIENT_ID!,
clientSecret: process.env.TWITCH_CLIENT_SECRET!,
}),
],
callbacks: {
async session({ session, token }) {
if (session?.user) {
// Pass the user ID to the session
// Note: We might need to extend the type definition for session.user
(session.user as any).id = token.sub;
}
return session;
},
async jwt({ token, user }) {
if (user) {
token.id = user.id;
}
return token;
},
},
})
export { handler as GET, handler as POST }

View File

@@ -0,0 +1,15 @@
import { NextResponse } from 'next/server';
import { getTwitchStatus } from '@/lib/twitch';
export async function GET(request: Request) {
const { searchParams } = new URL(request.url);
const username = searchParams.get('username');
if (!username) {
return NextResponse.json({ error: 'Username is required' }, { status: 400 });
}
const isLive = await getTwitchStatus(username);
return NextResponse.json({ isLive });
}

21
src/app/editor/page.tsx Normal file
View File

@@ -0,0 +1,21 @@
"use client";
import React, { useState } from 'react';
import StyleControls from '@/components/dashboard/StyleControls';
import PreviewFrame from '@/components/dashboard/PreviewFrame';
import { OverlaySettings, DEFAULT_SETTINGS } from '@/lib/types';
export default function EditorPage() {
const [settings, setSettings] = useState<OverlaySettings>(DEFAULT_SETTINGS);
const updateSettings = (newSettings: Partial<OverlaySettings>) => {
setSettings(prev => ({ ...prev, ...newSettings }));
};
return (
<main className="flex h-screen w-screen overflow-hidden bg-zinc-50 dark:bg-zinc-950 text-zinc-900 dark:text-zinc-100">
<StyleControls settings={settings} updateSettings={updateSettings} />
<PreviewFrame settings={settings} />
</main>
);
}

BIN
src/app/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

26
src/app/globals.css Normal file
View File

@@ -0,0 +1,26 @@
@import "tailwindcss";
:root {
--background: #ffffff;
--foreground: #171717;
}
@theme inline {
--color-background: var(--background);
--color-foreground: var(--foreground);
--font-sans: var(--font-geist-sans);
--font-mono: var(--font-geist-mono);
}
@media (prefers-color-scheme: dark) {
:root {
--background: #0a0a0a;
--foreground: #ededed;
}
}
body {
background: var(--background);
color: var(--foreground);
font-family: Arial, Helvetica, sans-serif;
}

34
src/app/layout.tsx Normal file
View File

@@ -0,0 +1,34 @@
import type { Metadata } from "next";
import { Geist, Geist_Mono } from "next/font/google";
import "./globals.css";
const geistSans = Geist({
variable: "--font-geist-sans",
subsets: ["latin"],
});
const geistMono = Geist_Mono({
variable: "--font-geist-mono",
subsets: ["latin"],
});
export const metadata: Metadata = {
title: "Create Next App",
description: "Generated by create next app",
};
export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
<html lang="en">
<body
className={`${geistSans.variable} ${geistMono.variable} antialiased`}
>
{children}
</body>
</html>
);
}

31
src/app/page.tsx Normal file
View File

@@ -0,0 +1,31 @@
import Link from 'next/link';
export default function Home() {
return (
<div className="grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20 font-[family-name:var(--font-geist-sans)]">
<main className="flex flex-col gap-8 row-start-2 items-center sm:items-start">
<h1 className="text-4xl font-bold">OpenChat Overlay</h1>
<p className="text-lg text-zinc-600 dark:text-zinc-400">
A free, open-source alternative to StreamElements chat overlay.
</p>
<div className="flex gap-4 items-center flex-col sm:flex-row">
<Link
href="/editor"
className="rounded-full border border-solid border-transparent transition-colors flex items-center justify-center bg-foreground text-background gap-2 hover:bg-[#383838] dark:hover:bg-[#ccc] text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5"
>
Go to Style Editor
</Link>
<a
className="rounded-full border border-solid border-black/[.08] dark:border-white/[.145] transition-colors flex items-center justify-center hover:bg-[#f2f2f2] dark:hover:bg-[#1a1a1a] hover:border-transparent text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5 sm:min-w-44"
href="https://gitea.ramforth.net/RamTech/twitchChatOverlayServer"
target="_blank"
rel="noopener noreferrer"
>
View on Gitea
</a>
</div>
</main>
</div>
);
}

View File

@@ -0,0 +1,50 @@
"use client";
import { signIn, signOut, useSession } from "next-auth/react";
import Link from "next/link";
export function LoginButton() {
return (
<button
onClick={() => signIn("twitch", { callbackUrl: "/editor" })}
className="rounded-full border border-solid border-transparent transition-colors flex items-center justify-center bg-[#9146FF] text-white gap-2 hover:bg-[#7a3acc] text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5"
>
Login with Twitch
</button>
);
}
export function LogoutButton() {
return (
<button
onClick={() => signOut({ callbackUrl: "/" })}
className="text-xs text-zinc-500 hover:text-zinc-700 dark:hover:text-zinc-300"
>
Sign out
</button>
);
}
export function UserProfile() {
const { data: session } = useSession();
if (!session?.user) return null;
return (
<div className="flex items-center gap-3">
{session.user.image && (
<img
src={session.user.image}
alt={session.user.name || "User"}
className="w-8 h-8 rounded-full border border-zinc-200 dark:border-zinc-800"
/>
)}
<div className="flex flex-col">
<span className="text-sm font-medium text-zinc-900 dark:text-zinc-100">
{session.user.name}
</span>
<LogoutButton />
</div>
</div>
);
}

View File

@@ -0,0 +1,77 @@
"use client";
import React from 'react';
import { OverlaySettings } from '@/lib/types';
interface PreviewFrameProps {
settings: OverlaySettings;
}
const MOCK_MESSAGES = [
{ id: 1, user: 'StreamElements', color: '#5b99ff', text: 'Welcome to the stream! Enjoy your stay.', badges: ['moderator'] },
{ id: 2, user: 'Viewer123', color: '#ff5b5b', text: 'PogChamp this overlay is amazing!', badges: ['subscriber'] },
{ id: 3, user: 'Lurker', color: '#5bff89', text: 'Can I get a shoutout?', badges: [] },
{ id: 4, user: 'ProGamer', color: '#ffb35b', text: 'What game are we playing today? kappa', badges: ['subscriber', 'turbo'] },
];
export default function PreviewFrame({ settings }: PreviewFrameProps) {
// Convert hex to rgb for background opacity
const r = parseInt(settings.backgroundColor.slice(1, 3), 16);
const g = parseInt(settings.backgroundColor.slice(3, 5), 16);
const b = parseInt(settings.backgroundColor.slice(5, 7), 16);
const rgbaBackground = `rgba(${r}, ${g}, ${b}, ${settings.backgroundOpacity})`;
const containerStyle: React.CSSProperties = {
fontFamily: settings.fontFamily,
backgroundColor: 'transparent', // The frame background is transparent, messages have their own bg or the container has it?
// In many overlays, the messages themselves are transparent or the whole container has a background.
// Based on the CSS generator: .chat-message has the background. Wait, no.
// In generateOverlayCSS:
// .chat-message { background-color: var(--chat-bg-color); ... }
// So the background applies to individual messages.
};
const messageStyle: React.CSSProperties = {
backgroundColor: rgbaBackground,
color: settings.textColor,
textShadow: settings.textShadow,
fontSize: settings.fontSize,
marginBottom: settings.messageSpacing,
};
return (
<div className="flex-1 bg-zinc-100 dark:bg-zinc-950 p-8 flex items-center justify-center h-full overflow-hidden">
<div className="relative w-full max-w-md aspect-[9/16] bg-[url('/file.svg')] bg-cover bg-center border-4 border-zinc-800 rounded-xl shadow-2xl overflow-hidden bg-zinc-800">
{/* Mock Stream Background (Optional) */}
<div className="absolute inset-0 bg-gradient-to-br from-indigo-900 to-purple-900 opacity-50"></div>
<div
className="absolute inset-0 flex flex-col justify-end p-4"
style={containerStyle}
>
{MOCK_MESSAGES.map((msg) => (
<div key={msg.id} className="p-2 rounded mb-2 animate-in fade-in slide-in-from-bottom-2" style={messageStyle}>
<div className="flex flex-wrap items-baseline">
{settings.showBadges && msg.badges.length > 0 && (
<span className="mr-2 inline-flex gap-1">
{msg.badges.map(badge => (
<span key={badge} className="w-4 h-4 bg-zinc-400 rounded-sm inline-block" title={badge}></span>
))}
</span>
)}
<span
className="font-bold mr-2"
style={{ color: settings.usernameColor === 'twitch' ? msg.color : settings.textColor }}
>
{msg.user}:
</span>
<span>{msg.text}</span>
</div>
</div>
))}
</div>
</div>
<div className="absolute top-4 right-4 text-xs text-zinc-500">Live Preview</div>
</div>
);
}

View File

@@ -0,0 +1,217 @@
"use client";
import React from 'react';
import { OverlaySettings } from '@/lib/types';
import SupportModule from './SupportModule';
interface StyleControlsProps {
settings: OverlaySettings;
updateSettings: (newSettings: Partial<OverlaySettings>) => void;
}
export default function StyleControls({ settings, updateSettings }: StyleControlsProps) {
const [copySuccess, setCopySuccess] = React.useState(false);
const handleChange = (e: React.ChangeEvent<HTMLInputElement | HTMLSelectElement>) => {
const { name, value, type } = e.target;
let newValue: string | number | boolean = value;
if (type === 'range') {
newValue = parseFloat(value);
} else if (type === 'checkbox') {
newValue = (e.target as HTMLInputElement).checked;
}
updateSettings({ [name]: newValue });
};
const handleEmoteChange = (e: React.ChangeEvent<HTMLInputElement>) => {
const { name, checked } = e.target;
updateSettings({
emotes: {
...settings.emotes,
[name]: checked,
},
});
};
const copyLink = () => {
// Mock token for now
const url = `${window.location.origin}/overlay/mock-token`;
navigator.clipboard.writeText(url);
setCopySuccess(true);
setTimeout(() => setCopySuccess(false), 2000);
};
return (
<div className="flex flex-col gap-6 p-6 bg-white dark:bg-zinc-900 border-r border-zinc-200 dark:border-zinc-800 h-full overflow-y-auto w-80 shrink-0">
{/* Copy Link Section */}
<div className="p-4 bg-indigo-50 dark:bg-indigo-900/20 border border-indigo-100 dark:border-indigo-800 rounded-lg">
<h3 className="text-xs font-semibold text-indigo-900 dark:text-indigo-200 uppercase tracking-wider mb-2">Overlay URL</h3>
<div className="flex gap-2">
<input
readOnly
value="/overlay/..."
className="flex-1 min-w-0 bg-white dark:bg-zinc-950 border border-zinc-200 dark:border-zinc-800 rounded text-xs px-2 py-1 text-zinc-500"
/>
<button
onClick={copyLink}
className="bg-indigo-600 hover:bg-indigo-700 text-white text-xs px-3 py-1 rounded transition-colors"
>
{copySuccess ? 'Copied!' : 'Copy'}
</button>
</div>
</div>
<div className="space-y-1">
<h2 className="text-xl font-bold text-zinc-900 dark:text-white">Style Editor</h2>
<p className="text-xs text-zinc-500">Customize your chat appearance</p>
</div>
{/* Resolution */}
<div className="space-y-2">
<label className="text-sm font-medium text-zinc-700 dark:text-zinc-300">Base Resolution</label>
<select
name="resolution"
value={settings.resolution}
onChange={handleChange}
className="w-full p-2 border rounded-md bg-zinc-50 dark:bg-zinc-800 border-zinc-300 dark:border-zinc-700 text-zinc-900 dark:text-white"
>
<option value="720p">720p (HD)</option>
<option value="1080p">1080p (Full HD)</option>
</select>
</div>
{/* Font Family */}
<div className="space-y-2">
<label className="text-sm font-medium text-zinc-700 dark:text-zinc-300">Font Family</label>
<select
name="fontFamily"
value={settings.fontFamily}
onChange={handleChange}
className="w-full p-2 border rounded-md bg-zinc-50 dark:bg-zinc-800 border-zinc-300 dark:border-zinc-700 text-zinc-900 dark:text-white"
>
<option value="Inter, sans-serif">Inter</option>
<option value="Roboto, sans-serif">Roboto</option>
<option value="'Open Sans', sans-serif">Open Sans</option>
<option value="Lato, sans-serif">Lato</option>
<option value="Montserrat, sans-serif">Montserrat</option>
<option value="'Press Start 2P', cursive">Pixel Art</option>
</select>
</div>
{/* Font Size */}
<div className="space-y-2">
<label className="text-sm font-medium text-zinc-700 dark:text-zinc-300">Font Size</label>
<div className="flex items-center gap-2">
<input
type="text"
name="fontSize"
value={settings.fontSize}
onChange={handleChange}
className="w-full p-2 border rounded-md bg-zinc-50 dark:bg-zinc-800 border-zinc-300 dark:border-zinc-700 text-zinc-900 dark:text-white"
/>
</div>
</div>
{/* Text Color */}
<div className="space-y-2">
<label className="text-sm font-medium text-zinc-700 dark:text-zinc-300">Text Color</label>
<div className="flex items-center gap-2">
<input
type="color"
name="textColor"
value={settings.textColor}
onChange={handleChange}
className="h-10 w-10 p-0 border-0 rounded overflow-hidden cursor-pointer"
/>
<input
type="text"
name="textColor"
value={settings.textColor}
onChange={handleChange}
className="flex-1 p-2 border rounded-md bg-zinc-50 dark:bg-zinc-800 border-zinc-300 dark:border-zinc-700 text-zinc-900 dark:text-white uppercase"
/>
</div>
</div>
{/* Background Color */}
<div className="space-y-2">
<label className="text-sm font-medium text-zinc-700 dark:text-zinc-300">Background Color</label>
<div className="flex items-center gap-2">
<input
type="color"
name="backgroundColor"
value={settings.backgroundColor}
onChange={handleChange}
className="h-10 w-10 p-0 border-0 rounded overflow-hidden cursor-pointer"
/>
<input
type="text"
name="backgroundColor"
value={settings.backgroundColor}
onChange={handleChange}
className="flex-1 p-2 border rounded-md bg-zinc-50 dark:bg-zinc-800 border-zinc-300 dark:border-zinc-700 text-zinc-900 dark:text-white uppercase"
/>
</div>
</div>
{/* Background Opacity */}
<div className="space-y-2">
<label className="text-sm font-medium text-zinc-700 dark:text-zinc-300 flex justify-between">
<span>Opacity</span>
<span>{Math.round(settings.backgroundOpacity * 100)}%</span>
</label>
<input
type="range"
name="backgroundOpacity"
min="0"
max="1"
step="0.01"
value={settings.backgroundOpacity}
onChange={handleChange}
className="w-full accent-indigo-600 cursor-pointer"
/>
</div>
{/* Toggles */}
<div className="space-y-4 pt-4 border-t border-zinc-200 dark:border-zinc-800">
<label className="flex items-center gap-3 cursor-pointer">
<input
type="checkbox"
name="showBadges"
checked={settings.showBadges}
onChange={handleChange}
className="w-5 h-5 rounded border-zinc-300 text-indigo-600 focus:ring-indigo-500"
/>
<span className="text-sm font-medium text-zinc-700 dark:text-zinc-300">Show Badges</span>
</label>
<label className="flex items-center gap-3 cursor-pointer">
<input
type="checkbox"
name="bttv"
checked={settings.emotes.bttv}
onChange={handleEmoteChange}
className="w-5 h-5 rounded border-zinc-300 text-indigo-600 focus:ring-indigo-500"
/>
<span className="text-sm font-medium text-zinc-700 dark:text-zinc-300">BTTV Emotes</span>
</label>
<label className="flex items-center gap-3 cursor-pointer">
<input
type="checkbox"
name="seventv"
checked={settings.emotes.seventv}
onChange={handleEmoteChange}
className="w-5 h-5 rounded border-zinc-300 text-indigo-600 focus:ring-indigo-500"
/>
<span className="text-sm font-medium text-zinc-700 dark:text-zinc-300">7TV Emotes</span>
</label>
</div>
<SupportModule />
</div>
);
}

View File

@@ -0,0 +1,104 @@
"use client";
import React, { useEffect, useState } from 'react';
const DEVELOPER_USERNAME = 'ramforth'; // Hardcoded developer username
export default function SupportModule() {
const [isLive, setIsLive] = useState(false);
useEffect(() => {
const checkStatus = async () => {
try {
const res = await fetch(`/api/twitch/status?username=${DEVELOPER_USERNAME}`);
const data = await res.json();
setIsLive(data.isLive);
} catch (error) {
console.error('Failed to check Twitch status:', error);
}
};
checkStatus();
// Poll every 5 minutes
const interval = setInterval(checkStatus, 5 * 60 * 1000);
return () => clearInterval(interval);
}, []);
return (
<div className="mt-auto pt-6 border-t border-zinc-200 dark:border-zinc-800">
<h3 className="text-xs font-semibold text-zinc-500 uppercase tracking-wider mb-4">
Support & Social
</h3>
<div className="flex flex-col gap-3">
{/* Live Indicator / Watch Button */}
<a
href={`https://twitch.tv/${DEVELOPER_USERNAME}`}
target="_blank"
rel="noopener noreferrer"
className={`
group relative flex items-center justify-between p-3 rounded-lg border transition-all duration-300
${isLive
? 'bg-zinc-900 border-indigo-500/50 hover:border-indigo-500 hover:shadow-[0_0_15px_-3px_rgba(99,102,241,0.4)]'
: 'bg-zinc-50 dark:bg-zinc-800/50 border-zinc-200 dark:border-zinc-700 hover:bg-zinc-100 dark:hover:bg-zinc-800'
}
`}
>
<div className="flex items-center gap-3">
{/* Avatar / Icon Placeholder */}
<div className={`
w-8 h-8 rounded-full flex items-center justify-center
${isLive ? 'bg-indigo-600 text-white' : 'bg-zinc-200 dark:bg-zinc-700 text-zinc-500'}
`}>
{/* Simple Twitch Icon SVG */}
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" className="transform scale-90">
<path d="M11.571 4.714h1.715v5.143H11.57zm4.715 0H18v5.143h-1.714zM6 0L1.714 4.286v15.428h5.143V24l4.286-4.286h2.143L22.286 11.143V0zm14.571 11.143l-3.428 3.428h-3.429l-3 3v-3H6.857V1.714h13.714Z"/>
</svg>
</div>
<div className="flex flex-col">
<span className={`text-xs font-bold ${isLive ? 'text-indigo-400' : 'text-zinc-700 dark:text-zinc-300'}`}>
ramforth
</span>
<span className="text-[10px] text-zinc-500">Developer</span>
</div>
</div>
{isLive ? (
<div className="flex items-center gap-1.5 px-2 py-1 rounded bg-red-500/10 border border-red-500/20">
<span className="relative flex h-2 w-2">
<span className="animate-ping absolute inline-flex h-full w-full rounded-full bg-red-400 opacity-75"></span>
<span className="relative inline-flex rounded-full h-2 w-2 bg-red-500"></span>
</span>
<span className="text-[10px] font-bold text-red-500 uppercase tracking-wide">LIVE</span>
</div>
) : (
<span className="text-[10px] text-zinc-400 group-hover:text-zinc-600 dark:group-hover:text-zinc-200 transition-colors">
Offline
</span>
)}
</a>
{/* Action Buttons */}
<div className="grid grid-cols-2 gap-2">
<a
href={`https://twitch.tv/${DEVELOPER_USERNAME}`}
target="_blank"
rel="noopener noreferrer"
className="flex items-center justify-center gap-2 px-3 py-2 text-xs font-medium text-white bg-[#9146FF] hover:bg-[#7a3acc] rounded-md transition-colors"
>
<span>Follow</span>
</a>
<a
href="#"
/* Replace # with actual donation link e.g., ko-fi.com/ramforth */
className="flex items-center justify-center gap-2 px-3 py-2 text-xs font-medium text-zinc-700 dark:text-zinc-200 bg-zinc-100 dark:bg-zinc-800 hover:bg-zinc-200 dark:hover:bg-zinc-700 rounded-md transition-colors border border-zinc-200 dark:border-zinc-700"
>
<span> Donate</span>
</a>
</div>
</div>
</div>
);
}

54
src/lib/twitch.ts Normal file
View File

@@ -0,0 +1,54 @@
// src/lib/twitch.ts
export async function getTwitchStatus(username: string) {
const clientId = process.env.TWITCH_CLIENT_ID;
const clientSecret = process.env.TWITCH_CLIENT_SECRET;
if (!clientId || !clientSecret) {
console.error('Missing Twitch API credentials');
return false;
}
try {
// 1. Get App Access Token
const tokenResponse = await fetch('https://id.twitch.tv/oauth2/token', {
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
body: new URLSearchParams({
client_id: clientId,
client_secret: clientSecret,
grant_type: 'client_credentials',
}),
});
if (!tokenResponse.ok) {
throw new Error('Failed to get Twitch access token');
}
const tokenData = await tokenResponse.json();
const accessToken = tokenData.access_token;
// 2. Check Stream Status
const streamResponse = await fetch(`https://api.twitch.tv/helix/streams?user_login=${username}`, {
headers: {
'Client-ID': clientId,
'Authorization': `Bearer ${accessToken}`,
},
});
if (!streamResponse.ok) {
throw new Error('Failed to fetch stream status');
}
const streamData = await streamResponse.json();
// If the data array is not empty, the user is live
return streamData.data && streamData.data.length > 0;
} catch (error) {
console.error('Error fetching Twitch status:', error);
return false;
}
}

35
src/lib/types.ts Normal file
View File

@@ -0,0 +1,35 @@
export interface OverlaySettings {
fontFamily: string;
fontSize: string;
textColor: string;
backgroundColor: string;
backgroundOpacity: number;
showBadges: boolean;
textShadow: string;
messageSpacing: string;
usernameColor: string; // 'custom' or 'twitch'
resolution: '720p' | '1080p';
emotes: {
bttv: boolean;
seventv: boolean;
ffz: boolean;
};
}
export const DEFAULT_SETTINGS: OverlaySettings = {
fontFamily: 'Inter, sans-serif',
fontSize: '16px',
textColor: '#ffffff',
backgroundColor: '#000000',
backgroundOpacity: 0.5,
showBadges: true,
textShadow: '1px 1px 2px rgba(0,0,0,0.8)',
messageSpacing: '0.5rem',
usernameColor: 'twitch',
resolution: '1080p',
emotes: {
bttv: true,
seventv: true,
ffz: true,
},
};

75
src/lib/utils.ts Normal file
View File

@@ -0,0 +1,75 @@
import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
import { OverlaySettings } from "./types";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
export function generateOverlayCSS(settings: OverlaySettings): string {
// Convert backgroundOpacity (0-1) to hex alpha if needed, or use rgba
// Here we assume CSS Injection will be used as a <style> tag or returned by API
const r = parseInt(settings.backgroundColor.slice(1, 3), 16);
const g = parseInt(settings.backgroundColor.slice(3, 5), 16);
const b = parseInt(settings.backgroundColor.slice(5, 7), 16);
const rgbaBackground = `rgba(${r}, ${g}, ${b}, ${settings.backgroundOpacity})`;
return `
:root {
--chat-font-family: ${settings.fontFamily};
--chat-font-size: ${settings.fontSize};
--chat-text-color: ${settings.textColor};
--chat-bg-color: ${rgbaBackground};
--chat-text-shadow: ${settings.textShadow};
--chat-spacing: ${settings.messageSpacing};
}
body {
background-color: transparent;
margin: 0;
padding: 0;
overflow: hidden;
font-family: var(--chat-font-family);
}
.chat-container {
width: 100%;
height: 100vh;
display: flex;
flex-direction: column;
justify-content: flex-end;
padding: 1rem;
box-sizing: border-box;
}
.chat-message {
background-color: var(--chat-bg-color);
color: var(--chat-text-color);
text-shadow: var(--chat-text-shadow);
font-size: var(--chat-font-size);
margin-bottom: var(--chat-spacing);
padding: 0.5rem;
border-radius: 4px;
word-wrap: break-word;
animation: fadeIn 0.2s ease-out;
}
.username {
font-weight: bold;
margin-right: 0.5rem;
}
.badges {
display: ${settings.showBadges ? 'inline-flex' : 'none'};
margin-right: 0.25rem;
vertical-align: middle;
gap: 0.25rem;
}
@keyframes fadeIn {
from { opacity: 0; transform: translateY(10px); }
to { opacity: 1; transform: translateY(0); }
}
`;
}

34
tsconfig.json Normal file
View File

@@ -0,0 +1,34 @@
{
"compilerOptions": {
"target": "ES2017",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
"incremental": true,
"plugins": [
{
"name": "next"
}
],
"paths": {
"@/*": ["./src/*"]
}
},
"include": [
"next-env.d.ts",
"**/*.ts",
"**/*.tsx",
".next/types/**/*.ts",
".next/dev/types/**/*.ts",
"**/*.mts"
],
"exclude": ["node_modules"]
}