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

This version

2.5.3

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

Uploaded Source

Built Distributions

portmod-2.5.3-cp37-abi3-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.7+ Windows x86-64

portmod-2.5.3-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.3-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.3.tar.gz.

File metadata

  • Download URL: portmod-2.5.3.tar.gz
  • Upload date:
  • Size: 317.9 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.3.tar.gz
Algorithm Hash digest
SHA256 4ec9628334d523a7230be6683d058f8d92adf1ec9a078edadafa9fbfe4072ced
MD5 6c06a277d1bc8eca529315fcba083aaf
BLAKE2b-256 dab2d5c4bb9f6268322038cddca7e9ea81ed1963ba87613a8ae81d990f6eda95

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.5.3-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.3 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.3-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 67842027514c2e11012c1ef27bd8c37a4b32d961cf8db49f86519dca23d0f020
MD5 8aded4d72602304aba92bf7d42f113b8
BLAKE2b-256 385bcc22ae685dbd1bd993d2253f3f8be0e143d8cd02da011c66c93a9239c048

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.3-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3d3d885c9d0808e87cf6e8e49252d8785328964991e8ced0357dff3adc9e201f
MD5 f8f44a885aad284ea4f4d150bca908c4
BLAKE2b-256 f7ab6cea60ff38411b0b6e0d4615a7460897a9c43f37cf71ad957691a54fb056

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.3-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 5673c7866fe0b53f6c181b7800a9107ae13e5a87a8dc8c062521aa1156a080f4
MD5 5a72523ce1e10750c63fc476271ed9cf
BLAKE2b-256 1147fdda13e018b750123a7b3eadfb70442fc0cff61a88ed2edccb1b19f5598d

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