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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.6+ Windows x86-64

portmod-2.3.2-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.2.tar.gz.

File metadata

  • Download URL: portmod-2.3.2.tar.gz
  • Upload date:
  • Size: 306.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.11.2 pkginfo/1.7.1 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.12

File hashes

Hashes for portmod-2.3.2.tar.gz
Algorithm Hash digest
SHA256 847a95a8fe3bb2cded879c2ec455409b0c491d533e5dd1e5a1f3ab976c5852d2
MD5 36e571477ea60cd83bcbb2796abe5861
BLAKE2b-256 0a4bd7137da85a1f175941643002836d6b30fef09af92237e07cd696282c20a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.3.2-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.2-cp36-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 68840268a19a01b4fe548ff8ca64fa343b066a4358752a3cfef10db9fce96cae
MD5 34914e15a588e6ab4eb5826f9a07811d
BLAKE2b-256 4196a45e31339c19b016493fd582526173bf74afca22e29adb441deb5f026df0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.3.2-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.2-cp36-abi3-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 8f676aca15dedd1f24cc38b2fe58c97342109950954f4162832d49dd9dbd573b
MD5 653b407ab7a327118ef4e1dea1b5537f
BLAKE2b-256 e36f6ea95213ba12cb8fc5e0d0897342da4ddcf982c608034034319f888290e2

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