Version 4.2.1

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [Ubuntu, macOS, Windows]
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
         include:
           - os: Ubuntu
             image: ubuntu-22.04
@@ -38,15 +38,15 @@ jobs:
         run: |
           env\Scripts\Activate.ps1
           pip install poetry pytest-github-actions-annotate-failures
-          poetry install
+          poetry install --all-extras
           coverage run -m pytest -v test/
 
       - name: Test on UNIX
         if: matrix.os != 'Windows'
         run: |
           source env/bin/activate
           pip install poetry pytest-github-actions-annotate-failures
-          poetry install
+          poetry install --all-extras
           coverage run -m pytest -v test/
 
       - name: Coverage & codecov

README.md

@@ -1,16 +1,18 @@
 # Portable Minecraft Launcher
 A fast, reliable and cross-platform command-line Minecraft launcher and API for developers.
-This launcher is compatible with the official Minecraft launcher's version specification.
-It also includes fast installation of common mod loaders such as Fabric, Forge and Quilt.
+Including fast and easy installation of common mod loaders such as Fabric, Forge, NeoForge and Quilt.
+This launcher is compatible with the standard Minecraft directories. 
 
-![PyPI - Version](https://img.shields.io/pypi/v/portablemc?label=PyPI%20version&style=flat-square)  ![PyPI - Downloads](https://img.shields.io/pypi/dm/portablemc?label=PyPI%20downloads&style=flat-square)
+[![PyPI - Version](https://img.shields.io/pypi/v/portablemc?label=PyPI%20version&style=flat-square)![PyPI - Downloads](https://img.shields.io/pypi/dm/portablemc?label=PyPI%20downloads&style=flat-square)](https://pypi.org/project/portablemc/)
 
-![illustration](doc/illustration.png)
+![illustration](https://github.com/mindstorm38/portablemc/blob/main/doc/illustration.png)
 
-*This launcher is tested for Python 3.7, 3.8, 3.9, 3.10, 3.11.*
+*This launcher is tested for Python 3.8, 3.9, 3.10, 3.11, 3.12.*
 
 ## Table of contents
 - [Installation](#installation)
+  - [With pip](#with-pip)
+  - [With Arch Linux](#with-arch-linux)
 - [Commands](#commands)
   - [Start Minecraft](#start-minecraft)
     - [Authentication](#authentication)
@@ -22,33 +24,48 @@ It also includes fast installation of common mod loaders such as Fabric, Forge a
     - [Miscellaneous](#miscellaneous)
   - [Search for versions](#search-for-versions)
   - [Authentication sessions](#authentication-sessions)
+  - [Shell completion](#shell-completion)
 - [Offline support](#offline-support)
 - [Certifi support](#certifi-support)
 - [Contribute](#contribute)
   - [Setup environment](#setup-environment)
   - [Contributors](#contributors)
   - [Sponsors](#sponsors)
-- [API Documentation (v4) ⇗](doc/API.md)
+- [API Documentation (v4.2) ⇗](https://github.com/mindstorm38/portablemc/blob/main/doc/API.md)
 
 ## Installation
+
+### With pip
+
 This launcher can be installed using `pip`.  On some linux distribution you might have to 
 use `pip3` instead of `pip` in order to run it on Python 3. You can also use 
 `python -m pip` if the `pip` command is not in the path and the python executable is.
 
 ```sh
-pip install --user portablemc
+pip install --user portablemc[certifi]
 ```
 
-It's recommended to keep `--user` because this installs the launcher for your
-current user only, it is implicit if you are not an administrator and if you are, it 
-allows not to modify other users' installations.
-
 After that, you can try to show the launcher help message using `portablemc` in your 
 terminal. If it fails, you should check that the scripts directory is in your user path
 environment variable. On Windows you have to search for a directory at 
 `%appdata%/Python/Python3X/Scripts` and add it to the user's environment variable `Path`. 
 On UNIX systems it's `~/.local/bin`.
 
+You can opt-out from the `certifi` optional feature if you don't want to depend on it,
+learn more in the [Certifi support](#certifi-support) section.
+
+> [!TIP]
+> It's recommended to keep `--user` because this installs the launcher for your current 
+> user only and does not pollute other's environments, it is implicit if you are not an 
+> administrator and if you are, it allows not to modify other users' installations.
+
+### With Arch Linux
+
+For Arch Linux users, the package is available as `portablemc` in the 
+[AUR](https://aur.archlinux.org/packages/portablemc).
+
+*This is currently maintained by Maks Jopek, Thanks!*
+
 ## Commands
 Arguments are split between multiple commands. 
 For example `portablemc [global-args] <cmd> [args]`. 
@@ -219,8 +236,10 @@ these are discarded in the bin directory, for example
 These arguments can be used together to fix various issues (e.g. wrong libc being linked
 by the LWJGL-provided natives).
 
-*Note that these arguments are compatible with, and executed after the `--lwjgl` argument.
-You must however ensure that excluded lib and included binaries are compatible.*
+> [!NOTE]
+> Note that these arguments are compatible with, and executed after the `--lwjgl` 
+> argument. You must however ensure that excluded lib and included binaries are 
+> compatible.
 
 #### Miscellaneous
 With `--dry`, the start command does not start the game, but simply installs it.
@@ -257,6 +276,16 @@ you need to log into an old Mojang account (being phased out by Mojang).
 **Your password is not saved!** Only tokens are saved *(the official launcher also does 
 that)* in the file `portablemc_auth.json` in the working directory.
 
+### Shell completion
+The launcher can generate shell completions scripts for Bash and Zsh shells through the
+`portablemc show completion {bash,zsh}` command. If you need precise explanation on how
+to install the completions, read this command's help message. **This command needs to be
+re-run for every new version of the launcher**, you're not affected if you directly eval
+the result.
+
+*Note that Zsh completion scripts can be used both as an auto-load script and as
+evaluated one.*
+
 ## Offline support
 This launcher can be used without internet access under certain conditions. Launching
 versions is possible if all required resources are locally installed, it is also possible

doc/API.md

@@ -3,7 +3,7 @@ This page documents the public API of the launcher. This launcher
 library provides high flexibility for launching Minecraft in many
 environments.
 
-Documented version: `4.0.0`.
+Documented version: `4.2`.
 
 ## Table of contents
 - [File structure](#file-structure)