@four-leaf-studios/rl-overlay 1.0.0

package/src/hooks/useReplay.ts

@@ -0,0 +1,21 @@
+import { useEvent, useEventSelector } from "@four-leaf-studios/rl-socket-hook";
+
+const useReplay = () => {
+  const replayEndEvent = useEvent("game:replay_end");
+  const replayStartEvent = useEvent("game:replay_start");
+  const isReplay = useEventSelector(
+    "game:update_state",
+    (state) => state?.game?.isReplay
+  );
+
+  const disabled = (!replayStartEvent && !isReplay) || replayEndEvent;
+
+  return {
+    active: !disabled,
+    replayEndEvent,
+    replayStartEvent,
+    isReplay,
+  };
+};
+
+export default useReplay;

package/src/hooks/useShowGameComponents.ts

@@ -0,0 +1,14 @@
+import { useEvent, useEventSelector } from "@four-leaf-studios/rl-socket-hook";
+
+const useShowGameComponents = () => {
+  const gameInitialized = useEvent("game:initialized");
+  const matchDestroyed = useEvent("game:match_destroyed");
+  const hasGame = useEventSelector(
+    "game:update_state",
+    (state) => state?.hasGame
+  );
+
+  return !!gameInitialized && !!hasGame && !matchDestroyed;
+};
+
+export default useShowGameComponents;

package/src/hooks/useTargetPlayer.ts

@@ -0,0 +1,21 @@
+import { useEventSelector } from "@four-leaf-studios/rl-socket-hook";
+
+const useTargetPlayer = () => {
+  const targetPlayer = useEventSelector("game:update_state", (state) => {
+    if (!state?.game.hasTarget) return null;
+
+    const target = state?.game?.target;
+
+    if (!state?.players || !target) return null;
+
+    const player = Object.values(state?.players)?.find(
+      (player) => player.id === target
+    );
+
+    return player;
+  });
+
+  return targetPlayer;
+};
+
+export default useTargetPlayer;

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./Overlay";
+export * from "@four-leaf-studios/rl-socket-hook";
+export * from "./hooks/index";

package/src/types.d.ts

@@ -0,0 +1,59 @@
+export type Team = {
+  id: "0" | "1";
+  broadcast_id: string | null;
+  session_id: string | null;
+  organization_id: string | null;
+  color_id: string | null;
+  name: string;
+  series_score: number;
+  logo: string | null;
+  side: "blue" | "orange";
+  created_at: string;
+  created_by: string | null;
+} & {
+  players?: Player[];
+  organization?: Organization;
+  color?: Color;
+};
+
+export type Player = {
+  id: string;
+  user_id: string | null;
+  team_id: string | null;
+  name: string;
+  picture: string | null;
+  created_at: string;
+  created_by: string | null;
+};
+
+export type Organization = {
+  id: string;
+  name: string;
+  logo: string | null;
+  created_at: string;
+  created_by: string | null;
+};
+
+export type Color = {
+  id: string;
+  name: string;
+  primary_color: string;
+  secondary_color: string;
+  mutual_color: string | null;
+  created_at: string;
+  created_by: string | null;
+};
+
+export type Broadcast = {
+  id: string;
+  name: string;
+  status: "active" | "inactive";
+  overlay_id: string | null;
+  featured: boolean;
+  top_info_text: string | null;
+  series_number: number;
+  created_at: string;
+  created_by: string | null;
+  teams: Team[];
+  overlay?: Overlay;
+};

package/test-overlay/README.md

@@ -0,0 +1,12 @@
+# React + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.

package/test-overlay/eslint.config.js

@@ -0,0 +1,33 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+
+export default [
+  { ignores: ['dist'] },
+  {
+    files: ['**/*.{js,jsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        ecmaFeatures: { jsx: true },
+        sourceType: 'module',
+      },
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      ...reactHooks.configs.recommended.rules,
+      'no-unused-vars': ['error', { varsIgnorePattern: '^[A-Z_]' }],
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+]

package/test-overlay/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

package/test-overlay/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "test-overlay",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.22.0",
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "@vitejs/plugin-react": "^4.3.4",
+    "eslint": "^9.22.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.19",
+    "globals": "^16.0.0",
+    "vite": "^6.3.1"
+  }
+}