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.

Portmod is a community more than it is a single tool. As there are far more mods in existence than could possibly be packaged by the developers of portmod, we rely on community contributions from users to keep the mod package repositories accurate, up to date and relevant. See the game-specific guides on the Wiki for details regarding how to contribute.

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

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

Uploaded Source

Built Distributions

portmod-2.6.2-cp37-abi3-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.7+ Windows x86-64

portmod-2.6.2-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.7 MB view details)

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

portmod-2.6.2-cp37-abi3-macosx_11_0_universal2.whl (4.6 MB view details)

Uploaded CPython 3.7+ macOS 11.0+ universal2 (ARM64, x86-64)

File details

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

File metadata

  • Download URL: portmod-2.6.2.tar.gz
  • Upload date:
  • Size: 397.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for portmod-2.6.2.tar.gz
Algorithm Hash digest
SHA256 b5b4b1c6f43de4287ae634ab9809eb1e27bfc48ec46dfce9b97bac12edc5042d
MD5 5f07dd308f083e7a0234de5bdd7e462c
BLAKE2b-256 d57452ed3dae9a56583547b2440702c88f2f4f0f6a8186a06784bf2306f1e57d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.6.2-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 3.1 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.6.2-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d3221a0f5dd26acef4500d37a185f33a93b1ff1317941ebd94b851c2efa3f6bf
MD5 cabae1d637fc0906bbd023a108467985
BLAKE2b-256 d3d97eca022d63df936f7db606979f7517eb3d6de978d374e8a95b0ffac16e8c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.6.2-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 41f71ca87989dcfe8ebd1f2d10a60c02dd30bb6f34aae00207bcbf31a89d3d40
MD5 7f36f7e5d85c55f441696b9c3b680e13
BLAKE2b-256 592da274c29330961df78c9dbd17bfec9d6ce7245bda30e340e0eb0256a0523d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.6.2-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 c74539255a6a43819b74729144df4d64bc0700ea76530b2603630178e850df83
MD5 380879f0331c714fa647c51d82f19f74
BLAKE2b-256 1f5e77ac815e32bb01ba00e499ba4720b241b3e673717f23ead4f56f29404f01

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