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

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

Uploaded Source

Built Distributions

portmod-2.3.3-cp36-abi3-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.6+ Windows x86-64

portmod-2.3.3-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.9 MB view details)

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

portmod-2.3.3-cp36-abi3-macosx_11_0_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.6+ macOS 11.0+ x86-64

File details

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

File metadata

  • Download URL: portmod-2.3.3.tar.gz
  • Upload date:
  • Size: 298.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for portmod-2.3.3.tar.gz
Algorithm Hash digest
SHA256 016ed63bcd3a0d297add0fd8524d0529101dd37397cf6b698df6d42b447cba02
MD5 fbb440bea35d16a76fe3eca808fe959f
BLAKE2b-256 1ee43d107a41f783c645b7967638e3d22a7fc2f6d1d1f6562eaa7884a277d3b6

See more details on using hashes here.

File details

Details for the file portmod-2.3.3-cp36-abi3-win_amd64.whl.

File metadata

  • Download URL: portmod-2.3.3-cp36-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.6+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for portmod-2.3.3-cp36-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 37d0e7ae8873099ad9eef30507ff6d88afafcb8df868b805846cc30e86b3dd44
MD5 acee1f3f3d4191c09fb600ee091ae4ed
BLAKE2b-256 ca8a159c905d9618211fc590945a3c060ebb97735451ae3ca716985f5be3de0c

See more details on using hashes here.

File details

Details for the file portmod-2.3.3-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: portmod-2.3.3-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: CPython 3.6+, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for portmod-2.3.3-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 32af664ac380fcfa9f3286b5b51aaa9d933745e078ad8bdbed319c36f193c71e
MD5 2e8aea0034d79e0a731d5f77ee6857f1
BLAKE2b-256 6d0f0d810c953e3930e8a48b7d4bfcbdeeaa5afc2ef3f328ac9f545a395394d6

See more details on using hashes here.

File details

Details for the file portmod-2.3.3-cp36-abi3-macosx_11_0_x86_64.whl.

File metadata

  • Download URL: portmod-2.3.3-cp36-abi3-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: CPython 3.6+, macOS 11.0+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.9

File hashes

Hashes for portmod-2.3.3-cp36-abi3-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 aebad1c046d528f5e2eccf4a1f468df8aeb74d173ac7437a23966d95aacd43f8
MD5 bd2139c2017b67e29522ef5a874a88e0
BLAKE2b-256 e516d79b64b9ff830d3359db012f68c57e0e9b7aa83e48d583ec2bce1ef3d8b3

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