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 existance 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.5.7.tar.gz (318.2 kB view details)

Uploaded Source

Built Distributions

portmod-2.5.7-cp37-abi3-win_amd64.whl (2.9 MB view details)

Uploaded CPython 3.7+ Windows x86-64

portmod-2.5.7-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.8 MB view details)

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

portmod-2.5.7-cp37-abi3-macosx_11_0_universal2.whl (4.4 MB view details)

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

File details

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

File metadata

  • Download URL: portmod-2.5.7.tar.gz
  • Upload date:
  • Size: 318.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.5.7.tar.gz
Algorithm Hash digest
SHA256 a5e42edb7b5a95620376c02b8d2fc8f1b5eec42f96605a712b066c745842ff76
MD5 9f239abbd0c23b631e42a008c45722ca
BLAKE2b-256 5236891038d4c54fd21428f4fd1646217a2c17b6860e30064f97aa9c66640bf7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.5.7-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.9 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.5.7-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 9c4401b7e689c5f337469c35dc3ec680d23b28736d16e0c834889bd3f0b0d6cf
MD5 93be4b00a181e4a9dd03632423c9a8c0
BLAKE2b-256 2db35418991e874b108d5468175fbc6007c3eebbae5fc4761e768aba87aa929e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.7-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6f5be43f9d3065efe9714ebde64b0148f3f2e4de224995b7cd0490f7346db5ee
MD5 f1dc14bdfa3b20eb651c2038f41a3e74
BLAKE2b-256 498a905644591342cddd8c90430f1d144f2b46028ceb8f49b33ebe9e075ad41d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.7-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 e199c5d5bd69ce61ef63dece70f3956e27e0774142c030ac90122fb76bf3d8eb
MD5 e4dca44d6a39c11c238ee06e7282ebd1
BLAKE2b-256 91bc140f98620c21157bdb4ac56f21d8ce154ad42265a6fb3ee0b13728aa4d00

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