Skip to content

Introduce Scroll WC Tools - #536

Draft
n3ptune-plan3t wants to merge 2 commits into
noctalia-dev:mainfrom
n3ptune-plan3t:main
Draft

Introduce Scroll WC Tools#536
n3ptune-plan3t wants to merge 2 commits into
noctalia-dev:mainfrom
n3ptune-plan3t:main

Conversation

@n3ptune-plan3t

Copy link
Copy Markdown

Plugin

  • Id: <author>/<plugin>
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

ScrollWC-specific bar widgets for Noctalia Shell v5 running under the Scroll compositor. Mirrors the ScrollScroller / ScrollTrails / ScrollSubmap integration from dawsers/gtkshell for Noctalia.

External dependencies

Scroll WC

Testing

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor:
  • Noctalia version tested against:
  • Plugin API level: 8

Screenshots / Videos

screenshot_20260830_112229-region screenshot_20260830_112202-region

Checklist

Ready-for-review requirement: Every box in this section must be checked. If any statement is not true, keep the
pull request as Draft. An explanation does not replace a required check.

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the
    README template, documents
    every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • I created thumbnail.webp with the thumbnail generator.
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and
    understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

Plugins run as trusted, unsandboxed Luau in the user's session. Confirm:
Ready-for-review requirement: Every attestation below must be checked.

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

Add README for Scroll Tools plugin detailing features, requirements, and usage.
@ItsLemmy

Copy link
Copy Markdown
Contributor
  1. blocking - scroll-tools/plugin.toml:1
    The manifest fails repository validation on every required axis. Root fields icon and
    dependencies are missing (scroll-tools/plugin.toml:1), none of the four tags Bar,
    Panel, Compositor, Utility (scroll-tools/plugin.toml:8) are in the validator's
    allowed tag set, and description is 222 characters (scroll-tools/plugin.toml:7) while
    catalog descriptions must be at or below 120. All of these errors are introduced by this
    PR: the validator passes on a clean checkout of latest main (124 manifests) and fails
    only for scroll-tools on the merge. The GitHub validate check on the PR head is also a
    FAILURE, matching the local run. The plugin cannot be merged until the manifest is fixed.

  2. blocking - scroll-tools/README.md:1
    The README fails README validation on ten points: no short introduction below the title
    (scroll-tools/README.md:3), missing required ## Plugin section, missing required
    ## Usage section, the Plugin section must document the manifest id
    n3ptune-plan3t/scroll-tools, the three widget entries (scroller, trails, submap)
    and the panel entry (scroller-controls) must be documented as backticked entry ids,
    the panel IPC command noctalia msg panel-toggle n3ptune-plan3t/scroll-tools:scroller-controls
    is missing, and the ## Settings - plugin.toml:15 heading (scroll-tools/README.md:94)
    is not recognized as a Settings section because the validator matches the exact heading
    name. The README is detailed and useful, but it does not follow the required
    README_TEMPLATE structure.

  3. non-blocking - pull request body
    The PR body still carries the unfilled template id placeholder <author>/<plugin> and
    an empty Noctalia version tested against: field. Every mandatory checklist box is
    checked (exactly one plugin type, one compositor under Testing, all Checklist items, all
    Code review attestation items) and the enforce check passes, so the checklist gate is
    satisfied, but the unfilled metadata fields should be completed before the PR is merged.
    The manifest id in plugin.toml (n3ptune-plan3t/scroll-tools) itself matches the
    directory name, and the README discloses AI-generated content at the top
    (scroll-tools/README.md:1), which is transparent rather than deceptive.

@ItsLemmy
ItsLemmy marked this pull request as draft August 30, 2026 18:51
@n3ptune-plan3t

Copy link
Copy Markdown
Author

@ItsLemmy thank you for detailed explanation, i will try to fix this one by one when i get time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants