mudlet/docs
Vadim Peretokin f7da6ca3da
improve: ship every default package as an mpackage (#9626)
#### Brief overview of PR changes/additions

- Every package Mudlet preinstalls now lives in `src/packages/<name>/`,
holding its `config.lua`, `.xml` and the `.mpackage` built from them -
previously they were scattered across `src/` and `src/mudlet-lua/lua/`,
and four had no metadata at all.
- The game loaders (Carrion Fields, Icesus, MorgenGrauen, Medievia) and
the two `mudlet.org` dev packages shipped as bare xml, so the Package
Manager showed them with no version, author or description. They are
packaged now, keeping their existing package names so nothing renames on
upgrade.
- New `DefaultPackagesTest` walks the preinstall table for seven games,
checks every queued path is really compiled in, and installs all 15
archives.

#### Motivation for adding to Mudlet

An mpackage carries Mudlet's metadata and a bare xml cannot. Keeping
each package's sources next to its archive also makes the Lua reviewable
in diffs, which a committed zip on its own is not.

#### Other info

Stacked on #9624, whose check now covers all 15 packages. The IRE mapper
stays an xml because upstream publishes it that way and
`update-3rdparty.yml` overwrites it weekly. Package repository PR
Mudlet/mudlet-package-repository#746 updates the sync paths and must
merge right after this.

#### Test case

`ctest` 66/67 locally (`TKeySequenceEditTest` is the known headless
flake - passes under openbox); `DefaultPackagesTest` 28/28; `python3
CI/check-mpackage-sync.py --base-ref origin/development` clean.

Assisted-by: Claude:claude-opus-5

---------

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2026-08-04 10:18:48 +02:00
..
package-capture-audits add: starter interface with health bars, map and chat for new players (#9454) 2026-07-26 08:43:21 +02:00
AI-ASSISTANTS.md Infra: Move developer documentation to /docs (#8120) 2025-08-27 10:22:23 +02:00
ai-instructions.md infrastructure: slim down the AI assistant instructions (#9511) 2026-07-26 15:23:14 +02:00
CODE_OF_CONDUCT.md Infra: Move developer documentation to /docs (#8120) 2025-08-27 10:22:23 +02:00
CONTRIBUTING.md Infrastructure: update CONTRIBUTING.md with AI coding guidelines (#9224) 2026-04-29 06:57:35 +02:00
demo-videos.md infrastructure: document how to record before & after demo videos (#9482) 2026-07-22 09:29:30 +02:00
FUNDING.yml Infra: Move developer documentation to /docs (#8120) 2025-08-27 10:22:23 +02:00
GITHUB.md Infra: Move developer documentation to /docs (#8120) 2025-08-27 10:22:23 +02:00
libmudlet-perf-baseline.md improve: ship every default package as an mpackage (#9626) 2026-08-04 10:18:48 +02:00
libmudlet-widgets-report.md infrastructure: harden the Widgets audit script and refresh its baseline (#9516) 2026-07-26 18:05:59 +02:00
platform-builds.md infrastructure: slim down the AI assistant instructions (#9511) 2026-07-26 15:23:14 +02:00
README.md Infra: Move developer documentation to /docs (#8120) 2025-08-27 10:22:23 +02:00
SUPPORT.md Infra: Move developer documentation to /docs (#8120) 2025-08-27 10:22:23 +02:00

docs Directory

This directory contains documentation files intended for developers and contributors that help manage the Mudlet project's development workflow.

Files and Their Purpose

Community & Contribution Files

  • CODE_OF_CONDUCT.md - Community standards and behavior expectations
  • CONTRIBUTING.md - Guidelines for contributing to the project
  • SUPPORT.md - Information on getting help and support
  • FUNDING.yml - Sponsorship and funding information for GitHub's sponsor button

Project Infrastructure Explanations

  • AI-ASSISTANTS.md - List of info on Mudlet left for AI assistants to find
  • GITHUB.md - List of files and their purpose in the ".github" directory
    • (Note: These are deliberately listed and explained here, and not in a .github/README.md file as that would take precendence over the /README.md file for the project.)