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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.6+ Windows x86-64

portmod-2.3.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.0 MB view details)

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

portmod-2.3.0-cp36-abi3-macosx_11_0_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.6+ macOS 11.0+ x86-64

File details

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

File metadata

  • Download URL: portmod-2.3.0.tar.gz
  • Upload date:
  • Size: 286.6 kB
  • Tags: Source
  • 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.0 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for portmod-2.3.0.tar.gz
Algorithm Hash digest
SHA256 b0a84263d2e935d9f90d8645f4a5f122b646c4a38497cd7aec8fcc17a93181aa
MD5 bbb392a98e359ebee11be72e38303295
BLAKE2b-256 ca474f6e31a354e5a0842a4cb877cb9babb45f388264ecea5d580be5afc3e9e8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.3.0-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.0 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.0-cp36-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 9f8de41101596e0a308e754790e3f36f1b24be770c987021ebae113de747d7ba
MD5 b358007e22ccf31f61b6d4050449b850
BLAKE2b-256 f899b7b0bead9aa027cf7f229bb315aa91f79d39e6092232f4c8d219cc32761b

See more details on using hashes here.

File details

Details for the file portmod-2.3.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: portmod-2.3.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: CPython 3.6+, manylinux: glibc 2.17+ 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.0 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for portmod-2.3.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2b1f72b42852d923756a8460940b35e60e3c4f6c6d39c276a657354eb38c5141
MD5 e900c573152f38b841eac32f49c95fc1
BLAKE2b-256 7801bde5b562678ea09f62bb82248caaaeb960cddd29958cd13fdc7682f4f67b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.3.0-cp36-abi3-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 2.6 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.0-cp36-abi3-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 2308eb34693a7d304c18c8cad96835ac14a26593cbae8e409f5842f3ba6fca9c
MD5 4e730d11c4a09f6055b45bdad6515a12
BLAKE2b-256 962c59de5753eca5a6a12e98c310537a6019289ac332328cd3d049ace86ba409

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