0.3.0

.github/workflows/release.yml

@@ -80,6 +80,7 @@ jobs:
               tag_name: ${{ github.ref_name }}
               name: ${{ github.ref_name }}
               prerelease: ${{ contains(github.ref_name, 'rc') }}
+              generate_release_notes: true
               body: |
                 ## Changelog
                 ${{ needs.bump.outputs.release-body }}

.gitignore

@@ -1,6 +1,3 @@
-# Mkdocs
-venv
-
 # Wally
 Packages
 DevPackages

README.md

@@ -4,4 +4,4 @@
 [![release](https://img.shields.io/github/v/release/luminlabsdev/plugin-framework)](https://github.com/luminlabsdev/plugin-framework/releases/latest)
 [![discord](https://img.shields.io/discord/1105688855375511642?logo=discord&logoColor=white&label=discord&color=4d3dff)](https://luminlabsdev.github.io/link/discord)
 
-An extension of Lumin Framework with added plugin support and methods.
+An extension of Framework with added plugin support and methods.

dev.project.json

@@ -6,7 +6,7 @@
 		"ReplicatedStorage": {
 			"Plugin": {
 				"$path": "Packages",
-				"framework": {
+				"pluginframework": {
 					"$path": "src"
 				},
 				"Test": {

docs/changelog.md

@@ -1,3 +1,8 @@
+---
+hide:
+  - navigation
+---
+
 # Changelog
 
 All notable changes to this project will be documented in this file.
@@ -7,6 +12,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added new library API to create menus, toolbars, and toolbar buttons
+
+### Changed
+
+- Merged `Menu` library with new `Interface` library
+
 ## [0.2.0] - 2024-09-11
 
 ### Changed

docs/guides/creating-actions.md

@@ -0,0 +1 @@
+# Creating Actions

docs/guides/creating-menus.md

@@ -0,0 +1 @@
+# Creating Menus

docs/guides/creating-toolbars.md

@@ -0,0 +1 @@
+# Creating Toolbars

docs/guides/index.md

@@ -0,0 +1 @@
+# Setup

docs/guides/saving-data.md

@@ -0,0 +1 @@
+# Saving Data

docs/index.md

@@ -0,0 +1,10 @@
+---
+hide:
+  - toc
+  - navigation
+---
+
+An extension of Framework with added plugin support and methods.
+
+[Guides](./guides/){ .md-button .md-button--primary }
+[API Reference](./api/){ .md-button }

docs/installation.md

@@ -1,13 +1,18 @@
+---
+hide:
+  - navigation
+---
+
 # Installation
 
 ### Roblox
 
-1. Go to the [latest releases page](https://github.com/lumin-dev/LuminPluginFramework/releases/latest)
+1. Go to the [latest releases page](https://github.com/luminlabsdev/plugin-framework/releases/latest)
 2. Download `Standalone.rbxm`
 3. Select `Insert from file`, and find `Standalone.rbxm` in your designated downloads folder
 
 ### Wally
 
 1. Open a project in your favorite text editor
-2. Add `lumin/plugin-framework@^0.1.0` to your `wally.toml` file
-3. Run `wally install` the project should be inside of your `/Packages` directory.
+2. Add `lumin/plugin-framework@^0.3.0` to your `wally.toml` file
+3. Run `wally install` the project should be inside of your `/Packages` directory.

mkdocs.yml

@@ -0,0 +1,79 @@
+site_name: Lumin Plugin Framework
+repo_url: https://github.com/luminlabsdev/plugin-framework
+repo_name: plugin-framework
+copyright: Copyright © 2021 - 2024 Lumin Labs & Contributors
+edit_uri: edit/main/docs/
+nav:
+  - Home: index.md
+  - Guides:
+    - Setup: guides/index.md
+    - Saving Data: guides/saving-data.md
+    - Creating Toolbars: guides/creating-toolbars.md
+    - Creating Actions: guides/creating-actions.md
+    - Creating Menus: guides/creating-menus.md
+  - API: api/index.md
+  - Install: installation.md
+  - Changelog: changelog.md
+markdown_extensions:
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.superfences:
+      custom_fences:
+      - name: mermaid
+        class: mermaid
+        format: !!python/name:pymdownx.superfences.fence_code_format
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/luminlabsdev
+    - icon: fontawesome/brands/discord
+      link: https://luminlabsdev.github.io/link/discord
+theme:
+  name: material
+  favicon: assets/images/favicon.ico
+  font:
+    text: Inter
+    code: JetBrains Mono
+  icon:
+    edit: material/pencil
+    view: material/eye
+  features:
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tabs
+    - navigation.path
+    - navigation.top
+    - navigation.footer
+    - content.action.edit
+    - content.code.copy
+    - content.code.select
+    - content.tooltips
+  palette:
+
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: black
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      toggle:
+        icon: material/weather-night
+        name: Switch to system preference

src/Library/Action.luau

@@ -5,7 +5,7 @@ local plugin: Plugin = script:FindFirstAncestorWhichIsA("Plugin")
 
 -- Functions
 
-local function new(
+local function New(
 	name: string,
 	description: string,
 	icon: string,
@@ -20,5 +20,5 @@ end
 -- Module
 
 return {
-    new = new,
-}
+    New = New,
+}

src/Library/Menu.luau → src/Library/Interface/Menu.luau

@@ -3,7 +3,7 @@
 local HttpService = game:GetService("HttpService")
 local plugin: Plugin = script:FindFirstAncestorWhichIsA("Plugin")
 
-local Types = require(script.Parent.Parent.Types)
+local Types = require(script.Parent.Parent.Parent.Types)
 
 local Index = {}
 Index.__index = Index
@@ -35,7 +35,7 @@ local function PluginMenu(name: string, children: Types.MenuChildren, icon: stri
 	return Menu
 end
 
-local function new(name: string, children: Types.MenuChildren, icon: string?)
+local function New(name: string, children: Types.MenuChildren, icon: string?)
 	local self = setmetatable({
 		Menu = PluginMenu(name, children, icon or ""),
 	}, Index)
@@ -60,5 +60,5 @@ end
 -- Module
 
 return {
-	new = new,
+	New = New,
 }

src/Library/Interface/Toolbar.luau

@@ -0,0 +1,28 @@
+-- Variables
+
+local plugin = script:FindFirstAncestorWhichIsA("Plugin")
+
+local Index = {}
+Index.__index = Index
+
+-- Functions
+
+local function New(name: string)
+	local self = setmetatable({
+		Toolbar = plugin:CreateToolbar(name),
+        Buttons = {}
+	}, Index)
+	return self
+end
+
+function Index.Button(self: any, name: string, tooltip: string, image: string, onClick: () -> ())
+	local Button = self.Toolbar:CreateButton(name, tooltip, image)
+    Button.Click:Connect(onClick)
+    table.insert(self.Buttons, Button)
+end
+
+-- Module
+
+return {
+	New = New,
+}

src/Library/Interface/init.luau

@@ -0,0 +1,5 @@
+return {
+    Menu = require(script.Menu),
+    Toolbar = require(script.Toolbar),
+    Widget = require(script.Widget),
+}

src/init.luau

@@ -9,23 +9,31 @@ local Library = script.Library
 
 local Data = require(Library.Data)
 local Action = require(Library.Action)
-local Menu = require(Library.Menu)
+local Interface = require(Library.Interface)
 
 -- Module
 
 return {
+    -- Framework
 	Start = Lumin.Start,
     OnStart = Lumin.OnStart,
 	New = Lumin.New,
 	Worker = Lumin.Worker,
     Load = Lumin.Load,
-    version = "0.2.0",
+    version = "0.3.0", -- Uses plugin framework version
 
+    -- Unloading
 	Unloading = plugin.Unloading,
 
+    -- Actions
 	Data = Data,
 	Action = Action,
-	Menu = Menu,
 
+    -- Interface
+	Menu = Interface.Menu,
+    Toolbar = Interface.Toolbar,
+    Widget = Interface.Widget,
+
+    -- Plugin
 	Plugin = plugin,
 }

tests/test.server.luau

@@ -1,7 +1,7 @@
-local Framework = require(script.Parent.plugin_framework)
+local Framework = require(script.Parent.pluginframework)
 local Bool = Instance.new("BoolValue")
 
-local Menu = Framework.Menu.new("TestingMenu", {
+local Menu = Framework.Menu.New("TestingMenu", {
 	{ "ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png" },
 	{ "ActionB", "B", "rbxasset://textures/loading/robloxTilt.png" },
 	{
@@ -23,6 +23,6 @@ end)
 Bool.Name = "Toggle Menu"
 Bool.Parent = game
 
-Framework.Action.new("Shortcut", "A test shortcut", "rbxasset://textures/whiteCircle.png", function()
+Framework.Action.New("Shortcut", "A test shortcut", "rbxasset://textures/whiteCircle.png", function()
 	print("You did it!")
-end)
+end)

wally.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lumin/plugin-framework"
-version = "0.2.0"
+version = "0.3.0"
 registry = "https://github.com/UpliftGames/wally-index"
 realm = "shared"