Initial commit

Author: Inrixia

.github/workflows/build.yml

@@ -0,0 +1,35 @@
+name: "Validate & Build"
+
+on:
+ workflow_call:
+
+jobs:
+ Sanity:
+  name: Build
+  runs-on: ubuntu-latest
+
+  steps:
+   - uses: actions/checkout@v4
+
+   - name: Install pnpm 📥
+     uses: pnpm/action-setup@v4
+     with:
+      version: latest
+
+   - name: Install Node.js 📥
+     uses: actions/setup-node@v4
+     with:
+      cache: pnpm
+      node-version: latest
+
+   - name: Install dependencies 📥
+     run: pnpm install
+
+   - name: Build
+     run: pnpm run build
+
+   - name: Upload Build Artifacts
+     uses: actions/upload-artifact@v4
+     with:
+      name: luna-artifacts
+      path: ./dist

.github/workflows/releaseMaster.yml

@@ -0,0 +1,32 @@
+name: "[master] Release"
+
+on:
+ push:
+  paths-ignore:
+   - "**/*.md"
+   - ".vscode/**"
+
+jobs:
+ Build:
+  uses: ./.github/workflows/build.yml
+
+ Release:
+  name: Release latest on GitHub
+  needs: Build
+  runs-on: ubuntu-latest
+
+  steps:
+   - name: Download All Artifacts
+     uses: actions/download-artifact@v4
+     with:
+      name: luna-artifacts
+      path: ./dist/
+
+   - name: Publish latest release on GitHub
+     uses: marvinpinto/action-automatic-releases@latest
+     with:
+      repo_token: ${{ secrets.GITHUB_TOKEN }}
+      automatic_release_tag: latest
+      prerelease: false
+      title: Latest Release
+      files: ./dist/**

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

README.md

@@ -0,0 +1,71 @@
+# Luna Plugins
+
+This is a template & example of how to develop **[Tidal Luna](https://github.com/Inrixia/TidaLuna)** plugins.
+
+## Getting Started
+
+Follow these steps to create your own Luna plugin using this template:
+
+### 1. Clone the Repository
+
+```sh
+git clone https://github.com/Inrixia/luna-template.git luna-plugins
+cd luna-plugins
+```
+
+### 2. Install Node.js (if missing)
+
+If you don't have Node.js installed, use [nvm](https://github.com/nvm-sh/nvm):
+
+```sh
+nvm install node
+nvm use node
+```
+
+> This will install and use the latest Node.js version.
+
+### 3. Enable pnpm via Corepack
+
+[Corepack](https://nodejs.org/api/corepack.html) is included with Node.js 16.10+.
+
+```sh
+corepack enable
+corepack prepare pnpm@latest --activate
+```
+
+### 4. Install Dependencies
+
+```sh
+pnpm install
+```
+
+### 5. Start Developing
+
+- Edit files in the `plugins/Example` directory to build your plugin.
+- Use `pnpm run watch` to build and serve with hot reload.
+
+> While developing, you can install your local plugin into Tidal Luna using a local URL.  
+> For example, if your plugin is `@luna/example` and you are running the dev server, use:  
+> `http://127.0.0.1:3000/luna.example` as the install URL in Tidal Luna.
+
+### 6. Update the README
+
+Replace this README with information about your plugin:
+
+- What it does
+- How to use it
+- Any configuration or setup steps
+
+### 7. GitHub Actions: Workflow Permissions
+
+If you want to use the included GitHub Action in (`.github`) to automatically create releases, you must set your repository workflow permissions to **Read and write permissions**:
+
+1. Go to your repository's settings: `Settings > Actions > General` https://github.com/.../.../settings/actions
+1. Under **Workflow permissions**, select **Read and write permissions**.
+1. Click **Save**.
+
+This allows the GitHub Action to create releases on your behalf.
+
+---
+
+For more details, see the [Tidal Luna documentation](https://github.com/Inrixia/TidaLuna).

esbuild.config.ts

@@ -0,0 +1 @@
+import "luna/buildPlugins";

package.json

@@ -0,0 +1,22 @@
+{
+	"name": "@luna/template",
+	"description": "Template repo for making your own luna plugins",
+	"type": "module",
+	"scripts": {
+		"watch": "concurrently \"pnpm:build --watch\" pnpm:serve",
+		"build": "rimraf ./dist && tsx esbuild.config.ts",
+		"serve": "http-server ./dist -p 3000 -s --cors -c-1"
+	},
+	"devDependencies": {
+		"@types/node": "^22.14.1",
+		"@types/react": "^19.1.2",
+		"@types/react-dom": "^19.1.2",
+		"concurrently": "^9.1.2",
+		"http-server": "^14.1.1",
+		"luna": "link:../TidaLuna",
+		"oby": "^15.1.2",
+		"rimraf": "^6.0.1",
+		"tsx": "^4.19.3",
+		"typescript": "^5.8.3"
+	}
+}

plugins/Example/package.json

@@ -0,0 +1,11 @@
+{
+	"name": "@luna/example",
+	"description": "A blank canvas",
+	"author": {
+		"name": "Inrixia",
+		"url": "https://github.com/Inrixia",
+		"avatarUrl": "https://2.gravatar.com/avatar/eeaffef9eb9b436dccc58c6c44c9fe8c3528e83e3bf64e1c736a68dbe8c097d3"
+	},
+	"main": "./src/index.ts",
+	"type": "module"
+}

plugins/Example/src/Settings.tsx

@@ -0,0 +1,11 @@
+import React from "react";
+
+import { InfoMessage } from "@luna/lib";
+import { LunaSwitchSetting } from "@luna/ui";
+
+export const Settings = () => {
+	const onChange = React.useCallback((_: React.ChangeEvent<HTMLInputElement>, checked?: boolean) => {
+		InfoMessage(`Example switch is now ${checked ? "on" : "off"}`);
+	}, []);
+	return <LunaSwitchSetting title="Example Switch" desc="This is an example switch" onChange={onChange} />;
+};

plugins/Example/src/index.ts

@@ -0,0 +1,19 @@
+import { InfoMessage, redux, Signal, type LunaUnload } from "@luna/lib";
+import { intercept } from "plugins/lib/src/redux";
+
+InfoMessage(`Hello ${redux.store.getState().user.meta.profileName} from the Example plugin!`);
+
+// Example plugin settings
+export { Settings } from "./Settings";
+
+// Functions in unloads are called when plugin is unloaded.
+// Used to clean up resources, even listener dispose etc should be added here
+export const unloads = new Set<LunaUnload>();
+
+// Log to console whenever changing page
+intercept("page/SET_PAGE_ID", unloads, console.log);
+
+// Error signal allowing us to show error messages in the UI
+export const errSignal = new Signal<string | undefined>(undefined);
+
+errSignal._ = "Example plugin error signal";