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

This version

2.5.8

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.8.tar.gz (318.4 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.5.8-cp37-abi3-win_amd64.whl (2.9 MB view details)

Uploaded CPython 3.7+Windows x86-64

portmod-2.5.8-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.8-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.8.tar.gz.

File metadata

  • Download URL: portmod-2.5.8.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.8.tar.gz
Algorithm Hash digest
SHA256 82e1ab24bafa0d4e5523e12eb3fb80fe744ee755bf22a08445581f1932056298
MD5 867736fac0adae39661e7bda67aabfc7
BLAKE2b-256 b1c4f6158b8fc07a34aa86bd938ba4f86fa0d0f053d8765264b173966c640084

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.5.8-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.8-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 c6f6cdbeb0517bc502594c75c26b57823871effb588d17f62a4838b1d77c72cf
MD5 cdfa535cd4c2b839e670ec98b4d89baf
BLAKE2b-256 47c4d94e8199da1801ccf05384839518fd80ac344fecea1e249d38eba9799846

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.8-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e233baf1273a3147edd5e3076156a2a49b02c276bb776a2d79b7a12fc902b333
MD5 0d6fc39f579adee659da378e875f65b9
BLAKE2b-256 bd9aae28f0a1d6a034d6595a4fc865a6646eb6ada049b5ea7ca98a0406698e25

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.5.8-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 989ef96db53278f1e5a551fac6da0014d4c2351ca3bd6e978a6007a5d46842d3
MD5 41154bee65a95386eed65c2d3b37f199
BLAKE2b-256 86bf7b63535eede9b556938ec309602dcce02331604c4bb715353be9dfd35c36

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