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.

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

Uploaded Source

Built Distributions

portmod-2.5.4-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.4-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.4.tar.gz.

File metadata

  • Download URL: portmod-2.5.4.tar.gz
  • Upload date:
  • Size: 318.4 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.4.tar.gz
Algorithm Hash digest
SHA256 0d3fc22d0046fd295c93b58a3a97553dbdab1ca075e1dbbb169eb515b81b6e7c
MD5 24a51c22e587bdd878adb648be59b6ab
BLAKE2b-256 ba6616c43a419718c78c4d61f436ea99348b6ab9f7cd816cdfa31f4ebe1a511d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.4-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c9074630637a3347561e3bcbc11f708820eca846e0a564d1955db078042e7a8d
MD5 b75fd08be87ae47f75bda913d8687174
BLAKE2b-256 36998850917f0250e88b27683bb558b05d56b5ab1bad59aa85a5306b9e7d6f8f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.4-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 ccaa8ed2e163c82ece35e335e84abc9ef7585bf44fec06644550d12ead423c83
MD5 66456bc4ca334d54860fe85b300957f9
BLAKE2b-256 bb99497cbf76b07953fa30d1e96982f3637c5955e1fffaeaf91949d5606297f5

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