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.0.tar.gz (401.5 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.0-cp37-abi3-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.7+Windows x86-64

portmod-2.7.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.8 MB view details)

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

portmod-2.7.0-cp37-abi3-macosx_11_0_universal2.whl (4.8 MB view details)

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

File details

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

File metadata

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

File hashes

Hashes for portmod-2.7.0.tar.gz
Algorithm Hash digest
SHA256 58631c6568b4b828bb39e8531180df917573540fe16137fe020e54b30280ad51
MD5 bb5aab332ee6ab74bd0bdc5fcee66200
BLAKE2b-256 c413ce22ff723cd60dd9706bcaa039c8de1c752487ae276a9636e4d061c1d16f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portmod-2.7.0-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 3.1 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.7.0-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 ebaca59ca37f03afb5c4423a6d46f9551b9e9031b9a9ae0a04cc9f61bf85aae4
MD5 1fde59aa509268cec99555ac64b93327
BLAKE2b-256 65d0ea500b8731010923881d586944df63b91d74cdb6e5bd9cd0c4f81b9c2f1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.7.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ec9d360a94caeedb169d5c3355f3b22d74156acf37b6321d602dac77d31cf0d3
MD5 29f0a9853bf7344ddbc81e1f76abd716
BLAKE2b-256 8c1b2a1bf73f0f665ee1a36371dc95e0c44996d3b22860f0a4a4e55de7ebf60a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for portmod-2.7.0-cp37-abi3-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 fd81f85ea66d0909e3104c75dc0ac1fcb6f482056366fed4957c3b5cda12013d
MD5 32a6f05e395fc565bc44596c26e625b5
BLAKE2b-256 86c96d1235c07e0598848519b0e5fffa9e1915ffe7f82fd10146e8674a478a60

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