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.1

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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7+ Windows x86-64

portmod-2.5.1-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.1-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.1.tar.gz.

File metadata

  • Download URL: portmod-2.5.1.tar.gz
  • Upload date:
  • Size: 317.5 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.1.tar.gz
Algorithm Hash digest
SHA256 86f827f31cf91a6d50b1c0b85e0e1e5c6eaf9a36a7025cd80fcfbb377f208cb8
MD5 8bc37262e02867ac1344a0289f39fd5a
BLAKE2b-256 2d2077bf004557bcec45afc8c797b7799fcd2e32536fdfc370bcbe7389c05487

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.5.1-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.1-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 36dab787eec9207a7c64411a4fc6e238efe980a4315e760d1765f11361162a0b
MD5 672a6b152f3b7047410800a5af3c2255
BLAKE2b-256 76b44cb69802951be07438c17b96cbb9d0d557fc8e061513772d12f1b8022a89

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f11d3612bd9ec6cb160c71188e9525840b015874908643042c9c76480ce8976c
MD5 999adcfbd5ac16b00af24dcfbc810cce
BLAKE2b-256 8cb8da496466054d5b4a4ac425296fdff46047117e576a284e4a9f603796e225

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.1-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 416f407c3aa12702efedadb03086cc575ac2dbd68cadd1c902c0e382abc1046b
MD5 22681e6585aaacdf631d94c93b07a3e9
BLAKE2b-256 93b94ec4c261ffd740f35a6919c36831e3181e25457e842efb2d199c91a478bb

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