dev:manual:packages:installing

Find and install packages

A package is a versioned set of scripts published through smudgy. It may add automations, panes, mapper support, protocol handling, or other features. Packages are installed for a server, not globally across every MUD.

Find a package

Open a profile and choose Automations → Discover. Search by the feature or package name. A result shows its owner, description, version, and rating. Select it to read the README and inspect the published source before installing.

The Discover page with a search, package results, owner, version, rating, and selected README

Treat a package as code, even when it requests no special access. Read what it claims to do, check who published it, and inspect unfamiliar source. Ratings and download counts are useful context, not a security boundary.

Install and review access

Choose Install. Smudgy resolves the package and its dependencies, verifies the published files, and shows one permission review for the code that will run together.

The installation review listing the package and dependency permissions before consent

Read each capability and its target. A request to read one package data directory is narrower than a request to read an arbitrary path; access to one host is narrower than unrestricted network access. Cancel when the request does not fit the feature.

If the review says Effectively full access, the requested operation can have effects outside Smudgy's package sandbox. Running another program, loading a native library, and writing outside the package's private data directory require a source-level trust decision. See Recognize effects outside the sandbox.

Some packages ask for setup values such as a character name, a color, or a list of commands. These values belong to the installed package's configuration and can be edited later from its detail page.

Choose the option that installs and enables the package when you want it to load immediately. Installing it disabled is useful when you want to inspect its files and settings first.

After installation

The package appears under Installed. Its detail page shows:

  • the resolved version and dependency tree;
  • whether it is enabled and loaded;
  • the README and published source files;
  • configured parameters;
  • the permissions granted to its sandbox;
  • update, rating, and removal actions when available.

Runtime aliases and triggers created by the package appear under the package in Automations. They are read-only evidence of what loaded. Configure or disable the package instead of trying to save edits over generated items.

Private and local packages

Public packages can be discovered normally. Access to your own private published packages requires the matching signed-in account. Local packages are source folders on this computer and belong to the authoring workflow; see Modules and packages.

Next: Review package access and updates.