package.ron

// Every package has one of these at its root. The four fields the catalogue
// listing is made of — description, keywords, engine, permissions — are all read
// from HERE, so fixing a typo here fixes the listing when you publish the next
// version. Nothing is retyped on the website.
(
    // CHANGE THIS FIRST, and change it before you publish anything.
    //
    // An id is permanent: it is how the catalogue, a project's packages.ron and
    // every `pkg://` reference name your package forever, and the first person
    // to publish an id owns it. At least two lowercase dot-separated parts —
    // reverse-domain style, the way you would name a Java package.
    //
    //   com.yourname.ruler      ✅
    //   io.github.yourname.tool ✅  (fine if you have no domain)
    //   ruler                   ❌  needs at least two parts
    id: "com.example.ruler",

    // Shown in 📦 Packages and on the catalogue. Human words, not the id.
    name: "Ruler",

    // Semantic version. Bump it every time you publish; the catalogue offers a
    // person the newest version their engine can actually run.
    version: "1.0.0",

    // The one line somebody reads when deciding whether to install this. Say
    // what it DOES, not what it is. This is the listing's subtitle.
    description: "Measures the distance between the nodes you have selected, and draws it in the Scene view.",

    author: (name: "Your Name", url: "https://example.com"),

    // Anything you like. Pick one so people know where they stand.
    license: "MIT OR Apache-2.0",

    // How your package gets found. Search needs EVERY word to match, so a
    // person searching "measure distance" finds this only if both words are
    // somewhere here, in the name, or in the description. Two or three honest
    // ones beat ten hopeful ones.
    keywords: ["measure", "distance", "editor-tools"],

    // Which engine versions this works with. A bare "0.55.0" means ^0.55.0 —
    // the same caret rule Cargo uses. Say the OLDEST version you have actually
    // tried it on; the catalogue hides your package from anyone older, which is
    // better than them installing it and watching it fail.
    engine: ">=0.55.0",

    // What the package may reach for, BEYOND reading its own folder — which it
    // can always do. An undeclared capability is not refused when you call it,
    // it is ABSENT from your Lua, so asking for something you do not need only
    // costs you installs.
    //
    // This one needs nothing, which is why the list is empty rather than
    // missing: an explicit [] says "I thought about it".
    //
    //   Network  http.* — talking to a server
    //   Files    reading and writing anywhere in the project
    //   Browser  opening a page in the user's browser
    //
    // Anything you declare is shown to the person installing, and a package
    // that asks for something arrives switched OFF until they allow it.
    permissions: [],
)