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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7+ Windows x86-64

portmod-2.4.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.5 MB view details)

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

portmod-2.4.0-cp37-abi3-macosx_11_0_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.7+ macOS 11.0+ x86-64

File details

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

File metadata

  • Download URL: portmod-2.4.0.tar.gz
  • Upload date:
  • Size: 312.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for portmod-2.4.0.tar.gz
Algorithm Hash digest
SHA256 dfa2f7ee47d6ff0cae14e268fd603880260829d38796b07b24c3160113df67df
MD5 26651601ee4aafc5d29650b78992d8e8
BLAKE2b-256 8f5be6135051f969e893f8fc306f4ae62da9a5840178fa84cd7f169b50b19e15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.4.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.1 CPython/3.7.9

File hashes

Hashes for portmod-2.4.0-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 00076c72febbacd5e0064367e676d1986e13380c03137307f381864681e712e3
MD5 439dbc9b2226f6b0c5238d15bed0df96
BLAKE2b-256 23d5f44011ddb0ff641c9946d819309d6498c8ffd7f2293632f1800a944c50fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.4.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 48e65ce847ed01f0fc40d59871b6000f6980f4026b61da3b024a469b8cf07288
MD5 a78c1477b83a831395b8dea889e8a606
BLAKE2b-256 9a75a73de0102b8a52725396534d6f6dffe3985dd6450a7ad6f9c3a4c47d2bcd

See more details on using hashes here.

File details

Details for the file portmod-2.4.0-cp37-abi3-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for portmod-2.4.0-cp37-abi3-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5b84e80875096a55a0b514bdbc242e0c731b866372bd894199cd887a93abb96c
MD5 fba73733f07f2262efe79a47b7fdad8b
BLAKE2b-256 1735f98288143aae0411d39e9c74d34deb3f9761e060e1d4f7089e40bc3dd815

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