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

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.3.1.tar.gz (286.7 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.3.1-cp36-abi3-win_amd64.whl (2.3 MB view details)

Uploaded CPython 3.6+Windows x86-64

portmod-2.3.1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.0 MB view details)

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

portmod-2.3.1-cp36-abi3-macosx_11_0_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.6+macOS 11.0+ x86-64

File details

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

File metadata

  • Download URL: portmod-2.3.1.tar.gz
  • Upload date:
  • Size: 286.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for portmod-2.3.1.tar.gz
Algorithm Hash digest
SHA256 b9db465c3a1aea4b25028de639d8181406f6e9c9895644b930f7a3781f19df2f
MD5 afacf5c110ac6420c7c337651409c1db
BLAKE2b-256 accea4d036dfce4a8da8d2e8ef78cbfb4e101d5e5ec1104514bb220f2e5aacd1

See more details on using hashes here.

File details

Details for the file portmod-2.3.1-cp36-abi3-win_amd64.whl.

File metadata

  • Download URL: portmod-2.3.1-cp36-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.6+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for portmod-2.3.1-cp36-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 100df5cb3d503114f9be9a98ee89530521fce69989af1c8853bdce06c659dd25
MD5 e9003970783725d630faf67e9c57a278
BLAKE2b-256 c363c8386162baa31a6936a5591546ca83f07309d1c31efaff07395b8e89ad68

See more details on using hashes here.

File details

Details for the file portmod-2.3.1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: portmod-2.3.1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: CPython 3.6+, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for portmod-2.3.1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 27805b2b414399b320c342e8930ed648ec575ea4c2928c6253ddd8604f2bae16
MD5 510cb24efe5bd4ada9cffe58efd8ff93
BLAKE2b-256 58f1104f2177af46290f5b37c3105946c6a27c480fe23c2e11f17fa4e64465b9

See more details on using hashes here.

File details

Details for the file portmod-2.3.1-cp36-abi3-macosx_11_0_x86_64.whl.

File metadata

  • Download URL: portmod-2.3.1-cp36-abi3-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: CPython 3.6+, macOS 11.0+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.9

File hashes

Hashes for portmod-2.3.1-cp36-abi3-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 e29cb5d0cb575cb8c5d9e8ddd8f39c54ad769e9ad07633ee464ac33202275145
MD5 261bfdcc48e7bc87d6e2ea2f591e52e4
BLAKE2b-256 41ff1e71d7fbb7a15b9608ce212ce42795e6f01b672788ac6f16e34bb259544c

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