pluginjar

package
v1.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2026 License: AGPL-3.0 Imports: 5 Imported by: 0

Documentation

Overview

Package pluginjar reads what a Bukkit or Paper plugin jar says about itself: the name and version in its paper-plugin.yml or plugin.yml.

Index

Constants

This section is empty.

Variables

View Source
var ErrNotPlugin = errors.New("not a plugin jar: no paper-plugin.yml or plugin.yml with a name")

ErrNotPlugin is returned for a jar with no plugin descriptor, or a file that is not a jar.

Functions

This section is empty.

Types

type Info

type Info struct {
	Name    string
	Version string
	// FoliaSupported is the descriptor's folia-supported flag: Folia loads
	// only plugins that set it.
	FoliaSupported bool
}

Info is a plugin's self-description.

func Read

func Read(r io.ReaderAt, size int64) (Info, error)

Read returns the plugin's name and version, preferring paper-plugin.yml.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL