assets

Documentation

Index

• func Config() fs.FS
• func DefaultMOTD() string
• func EmbeddedConfig() ([]byte, bool)
• func HasEmbeddedConfig() bool
• func Legal() fs.FS
• func Lore() fs.FS
• func Skills() fs.FS
• func Version() string
• func Web() fs.FS

Functions

func Config

func Config() fs.FS

Config returns the embedded config filesystem (rooted inside config/).

func DefaultMOTD

func DefaultMOTD() string

DefaultMOTD returns the embedded MOTD string.

func EmbeddedConfig

func EmbeddedConfig() ([]byte, bool)

EmbeddedConfig returns the contents of the embedded openlore.yml, if any.

func HasEmbeddedConfig

func HasEmbeddedConfig() bool

HasEmbeddedConfig reports whether a real openlore.yml is embedded (not just the example file).

func Legal

func Legal() fs.FS

Legal returns the embedded third-party legal notices filesystem (rooted inside legal/). It contains THIRD_PARTY_NOTICES.md and a licenses/ directory with the full license text of every bundled dependency.

func Lore

func Lore() fs.FS

Lore returns the embedded docs filesystem (rooted inside lore/). Returns nil if the lore directory contains only the placeholder.

func Skills

func Skills() fs.FS

Skills returns the embedded skills filesystem (rooted inside skills/).

func Version

func Version() string

Version returns the embedded version string.

func Web

func Web() fs.FS

Web returns the embedded web assets filesystem (rooted inside web/).