Skip to main content

A CLI package manager for mods

Project description

Portmod

pipeline coverage PyPI Code style: black Supported Python versions Chat Checked with mypy Imports: isort pre-commit Contributor Covenant Translation status Rust Version

A cross-platform cli package manager for mods. Based on Gentoo's Portage package manager.

See the Documentation for details on Installation and Setup, and the Wiki for supported Game Engines.

Portmod is a community more than it is a single tool. As there are far more mods in existence than could possibly be packaged by the developers of portmod, we rely on community contributions from users to keep the mod package repositories accurate, up to date and relevant. See the game-specific guides on the Wiki for details regarding how to contribute.

Features

  • Automatic Downloads (where possible): If direct links are available to mod archive files, portmod will fetch them automatically. As many mods have restrictive licenses and are distributed via sites which do not provide direct links, this is not always possible.
  • Automatic patching: Mods are organized into packages which contain both the base mod and any necessary patches. Patches can be configured (in the package) to only be installed when certain other packages are installed, so that all you need to do when installing packages is choose the ones you want and all necessary patches will be included automatically.
  • Automatic Configuration: Mod packages can declare optional features (called Use Flags), which can either be independently enabled/disabled (local flags), or enabled/disabled along with other packages which share the same feature (global flags).
  • Structure Awareness: Portmod's package files contain information about the directory structure of the archives which explain precisely how the mod should be installed.
  • Automatic sorting (OpenMW): The install order and the load order of plugin and fallback archive files are sorted automatically based on rules defined in the packages. These rules can be customized with user rules.
  • Automatic updates: When mod updates are released and new package files are created in the portmod repository, you can find and update all your installed mods using a single command. Due to portmod requiring more information than upstream sources usually provide, will be a delay after the upstream mod is updated while new package files are created.
  • Dependencies: Portmod will automatically install dependencies for the mods you ask it to install.
  • Mod collections: Portmod supports both metapackages (packages containing lists of other packages which are distributed in the repository), as well as custom package sets (easy to set-up package lists that exist in the user's configuration).
  • Multiple Game Engines: Portmod just defines the package format and installation process, and has a programmable interface to allow custom game-engine-specific configuration. A list of supported Game Engines can be found on the Wiki.

Communication

Release announcements and other major news will be posted to the announcement mailing list. This list is read-only (see below for the list you can contact).

There are a number of ways to communicate with the developers and with other users:

Packaging status

Project details


Release history Release notifications | RSS feed

This version

2.9.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portmod-2.9.0.tar.gz (436.2 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

portmod-2.9.0-cp38-abi3-win_amd64.whl (6.6 MB view details)

Uploaded CPython 3.8+Windows x86-64

portmod-2.9.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ x86-64

portmod-2.9.0-cp38-abi3-macosx_14_0_universal2.whl (7.2 MB view details)

Uploaded CPython 3.8+macOS 14.0+ universal2 (ARM64, x86-64)

File details

Details for the file portmod-2.9.0.tar.gz.

File metadata

  • Download URL: portmod-2.9.0.tar.gz
  • Upload date:
  • Size: 436.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for portmod-2.9.0.tar.gz
Algorithm Hash digest
SHA256 5917e01e5898546caf34f58c7d9e3913274ed62f31c3cb17d90267e4a028ca80
MD5 f68a48e3ff073c87787fbc3b7007edb3
BLAKE2b-256 463963e62d0e39db8a63f767e9c683a459d7c07a011f6e327613f03f37cec6d2

See more details on using hashes here.

File details

Details for the file portmod-2.9.0-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: portmod-2.9.0-cp38-abi3-win_amd64.whl
  • Upload date:
  • Size: 6.6 MB
  • Tags: CPython 3.8+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for portmod-2.9.0-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 8a2af94bfde39a7a3d85c2d70278abdc0e96ba04f99ae7d6a98b88174c7141a9
MD5 3643512fe177378203dfe0672cb3fce0
BLAKE2b-256 4b56b01c8edf74b15b978838f55643880822b267fe7a130c05e31d8166a3f4ea

See more details on using hashes here.

File details

Details for the file portmod-2.9.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for portmod-2.9.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0b63f99a7a4b67c69d302dc1e1d42ff7b01849452348261cf96a180a16aa0da2
MD5 52d6df966c20791cbf490b5b0d561321
BLAKE2b-256 14dd325ee7a64b83437a526a1926892885324ac959ea241ef8257eddea2063b2

See more details on using hashes here.

File details

Details for the file portmod-2.9.0-cp38-abi3-macosx_14_0_universal2.whl.

File metadata

File hashes

Hashes for portmod-2.9.0-cp38-abi3-macosx_14_0_universal2.whl
Algorithm Hash digest
SHA256 e76e2d4633beb5cb5d78f94a7b69b67db2f216ef49e625166b82f1a0e76a9af1
MD5 4dd3f2a147aa660e89c7f170d266f5b0
BLAKE2b-256 d0bf319d70bc6ee71db15c76bca3099ef6f4254c219e6b228fa5efcf60c05321

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page