Skip to main content

A CLI package manager for mods

Project description

Portmod

pipeline Build status 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.

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

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.5.5.tar.gz (318.6 kB view details)

Uploaded Source

Built Distributions

portmod-2.5.5-cp37-abi3-win_amd64.whl (2.9 MB view details)

Uploaded CPython 3.7+ Windows x86-64

portmod-2.5.5-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.8 MB view details)

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

portmod-2.5.5-cp37-abi3-macosx_11_0_universal2.whl (4.4 MB view details)

Uploaded CPython 3.7+ macOS 11.0+ universal2 (ARM64, x86-64)

File details

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

File metadata

  • Download URL: portmod-2.5.5.tar.gz
  • Upload date:
  • Size: 318.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for portmod-2.5.5.tar.gz
Algorithm Hash digest
SHA256 393d273c25c6f3e054772469e70a8601500565e044a36ffb94c5b93ef75d0382
MD5 0b031b4db2bd9e33a73b51212e7a0958
BLAKE2b-256 502324d06b4e35079f5c532215b46f23218b9cf860f280576856ae95790a879f

See more details on using hashes here.

File details

Details for the file portmod-2.5.5-cp37-abi3-win_amd64.whl.

File metadata

  • Download URL: portmod-2.5.5-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: CPython 3.7+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for portmod-2.5.5-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 66a32e4e50fe787d80e2abb94e0f1b510d364340a0614dfffc71a1520068720a
MD5 086887f8586e08f9724da6c17b091c28
BLAKE2b-256 d79739fe68f68b4cbed85ff44fca119012d60ee7f4380842ff5ba2b07794a941

See more details on using hashes here.

File details

Details for the file portmod-2.5.5-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for portmod-2.5.5-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 571cfbc7b733b5f048471931bd16777fb19e163924a57d38c99fcb9cf97fd182
MD5 9c27b026c063434842be6de3212162b7
BLAKE2b-256 f6e4411773936fab948f61a4251ba9847f50d74d8aa8adcd56b9df47b346e30a

See more details on using hashes here.

File details

Details for the file portmod-2.5.5-cp37-abi3-macosx_11_0_universal2.whl.

File metadata

File hashes

Hashes for portmod-2.5.5-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 84eb357b2745e916412f75443e155bf925316ddf73bd97674e2c7d9c99549216
MD5 ebe5b89fd12db76bc2796b67ccba020e
BLAKE2b-256 d36b9ec792859c0a5f77be5231bf5009faef5516326759f274d729f27c38b84d

See more details on using hashes here.

Supported by

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