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

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

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

portmod-2.7.3-cp38-abi3-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.8+Windows x86-64

portmod-2.7.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.8 MB view details)

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

portmod-2.7.3-cp38-abi3-macosx_11_0_universal2.whl (4.7 MB view details)

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

File details

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

File metadata

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

File hashes

Hashes for portmod-2.7.3.tar.gz
Algorithm Hash digest
SHA256 cdb433579e196bc6c23671fae5f138f4be09c791164bbae1ed9e59101d0b6037
MD5 fe2c1b0ab91d9eee191f1e7d5c439fe7
BLAKE2b-256 d02d4664f99260d7d36a1e37d24f98edf960b8b8a1c1358894ad7124437c2394

See more details on using hashes here.

File details

Details for the file portmod-2.7.3-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: portmod-2.7.3-cp38-abi3-win_amd64.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: CPython 3.8+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for portmod-2.7.3-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 6c137bfd148a733baba7326955319d94ba99afe70fc94cec5afda943e3a235c9
MD5 061c10ec1603d8ea660c8016180226f4
BLAKE2b-256 e7cebbe702830051c61819a2f2ea33504a441478832fcb79b21de718707bbf46

See more details on using hashes here.

File details

Details for the file portmod-2.7.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for portmod-2.7.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 611f19bbc3b8fec27453c720192882350fe61f89e5d180d69ac4d141e770301e
MD5 b02afed8507424582ef799f06b77c7a0
BLAKE2b-256 b9ed12e28c81bae42b50f9b3d53483b98f917afe1914a62a579d566bbea8cb30

See more details on using hashes here.

File details

Details for the file portmod-2.7.3-cp38-abi3-macosx_11_0_universal2.whl.

File metadata

File hashes

Hashes for portmod-2.7.3-cp38-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 47116016238662fe86d81a7a94db5a0c7a6270aaefe0f00cba1aad539b93ee96
MD5 cbc9a7ce78c4ad2152a5da731b9ac349
BLAKE2b-256 96939d6818aee3578e5f6420a4b0241e2a11e8cb9b0444f3c06ca899a5b96571

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page