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

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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7+ Windows x86-64

portmod-2.5.6-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.6-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.6.tar.gz.

File metadata

  • Download URL: portmod-2.5.6.tar.gz
  • Upload date:
  • Size: 316.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.6.tar.gz
Algorithm Hash digest
SHA256 42a86a6c93ad420175b2234d60855a49e758e2e19fe910c436735bfd91499bc8
MD5 6551a4f36b79e7b698846d984e78d60b
BLAKE2b-256 a06b675fbf5e453a7c124f4da1af9cd6d64bc04ec2c1e4841f11ef3207f4b1e8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.5.6-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.6-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 82891200b235fc0fb36ed527c02f64722d7b383c93545878c8acf0637b51dd77
MD5 27bb72ab2de90e276f9faeb8788bb1ad
BLAKE2b-256 9d62eb085aaa946378884e8398cac6c1b9a5ca178c9d36c3c311f1b172423ea0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.6-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ce3298be190fec495455967466c099db9c8343d982f2bd28627f67a9679cbce7
MD5 a1ecd4310cb297fb45601630ea11604e
BLAKE2b-256 edd125c9f63c523a20b7c43858dc21ae5039cb68921bb61b2f63026a614e89cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.6-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 6af24186f7bc73cc41b62ad6b709d2997b2ec1f2328f01388925ed93a5f6b911
MD5 60ff34f9471abe1747ff96de6375ff2e
BLAKE2b-256 71ddfa1c7b72e1a4b5b522eeb1106239fc738bce569837b8545616a506753120

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