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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7+ Windows x86-64

portmod-2.5.0-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.0-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.0.tar.gz.

File metadata

  • Download URL: portmod-2.5.0.tar.gz
  • Upload date:
  • Size: 317.0 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.0.tar.gz
Algorithm Hash digest
SHA256 4f8817c64387fe5201c513efa70e97f79ad45e6f25bfe4dfc6670bc796c19e6d
MD5 e64a88844763a16267d0e42e3977f379
BLAKE2b-256 3d3ff0705ebc19bac36b0e9022f804e61cd08badd3519f06f75e89a1068bc558

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.5.0-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.0-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 293e171afd89d7f02578aac9c735c713b4404974d93e06b4ca69a6e8031a76de
MD5 f6105f16f57585698e90f89120c0cb2d
BLAKE2b-256 ee52d51bfd120b514b0c50b5d24c5863968a7f723834768daba809419289acef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4b5fee8c4a3b4d4e9ce9731b35ea3a17233dc93b39a488482de9ed7b71c57340
MD5 11115e20b6af69c53b7701210c3748a1
BLAKE2b-256 8713af6732e082db38275276d88cf381d4050f263e64cf50c30c2e083dbf073f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.0-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 8e2075ffb4edd0c8a39c98d16d822410d30c26140c4ad590807fe42636546452
MD5 112664f575f881ec1023c1571fd530b6
BLAKE2b-256 15f20a4c40f01867e6fdc9ab3daa18989bbb9ff9fc6c1fd045a504fec502c089

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