From 4368a8e81a9b9478066202807db4eb9586ecd78b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20Rozier?= Date: Tue, 16 Apr 2024 19:35:09 +0200 Subject: [PATCH] Updated README, update version to 4.3.0 and some typos --- README.md | 23 +++++++++++++++-------- doc/API.md | 2 +- portablemc/__init__.py | 2 +- portablemc/cli/lang.py | 2 +- pyproject.toml | 2 +- 5 files changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e9aedf99..72788e19 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ This launcher is compatible with the standard Minecraft directories. - [Setup environment](#setup-environment) - [Contributors](#contributors) - [Sponsors](#sponsors) -- [API Documentation (v4.2) ⇗](https://github.com/mindstorm38/portablemc/blob/main/doc/API.md) +- [API Documentation (v4.3) ⇗](https://github.com/mindstorm38/portablemc/blob/main/doc/API.md) ## Installation @@ -107,13 +107,19 @@ needed by the version before launching it. If you provide no version, the latest is started, but you can specify a version to launch, or a version alias: `release` or `snapshot` for the latest version of their type. -In addition to Mojang's vanilla versions, the launcher natively supports common mod -loaders such as **Fabric**, **Forge**, **NeoForge** and **Quilt**. To start such versions, -you can prefix the version with either `fabric:`, `forge:`, `neoforge:` or `quilt:` (or -`vanilla:` to explicitly choose a vanilla version). -Depending on the mod loader, the version you put after the colon is different: -- For Fabric and Quilt, you can directly specify the vanilla version, optionally followed - by `:`. +In addition to Mojang's versions, the launcher natively supports common mod +loaders: +[Fabric](https://fabricmc.net/), +[Forge](https://minecraftforge.net/), +[NeoForge](https://neoforged.net/), +[LegacyFabric](https://legacyfabric.net/) and +[Quilt](https://quiltmc.org/). +To start such versions, you can prefix the version with either `fabric:`, `forge:`, +`neoforge:`, `legacyfabric:` or `quilt:` (or `standard:` to explicitly choose a vanilla +version). Depending on the mod loader, the version you put after the colon is different: +- For Fabric, LegacyFabric and Quilt, you can directly specify the vanilla version, + optionally followed by `:`. Note that legacy fabric start 1.13.2 + by default and does not support more recent version as it's not the goal. - For Forge and NeoForge, you can put either a vanilla game version, optionally followed by `-`. Forge also supports `-latest` and `-recommended`, but NeoForge will always take the latest loader. @@ -260,6 +266,7 @@ you can instead search for many kinds of versions using the `-k` (`--kind`) argu - `forge`, show all recommended and latest Forge loader versions *(only 1.5.2 and onward can be started)*. - `fabric`, show all available Fabric loader versions. +- `legacyfabric`, show all available LegacyFabric loader versions. - `quilt`, show all available Quilt loader versions. The search string is optional, if not specified no filter is applied on the table shown. diff --git a/doc/API.md b/doc/API.md index d2e2ad33..0d320764 100644 --- a/doc/API.md +++ b/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.2`. +Documented version: `4.3`. ## Table of contents - [File structure](#file-structure) diff --git a/portablemc/__init__.py b/portablemc/__init__.py index 84cd4472..b1f68833 100644 --- a/portablemc/__init__.py +++ b/portablemc/__init__.py @@ -7,7 +7,7 @@ """ LAUNCHER_NAME = "portablemc" -LAUNCHER_VERSION = "4.2.1" +LAUNCHER_VERSION = "4.3.0" LAUNCHER_AUTHORS = ["Théo Rozier ", "Contributors"] LAUNCHER_COPYRIGHT = "PortableMC Copyright (C) 2021-2024 Théo Rozier" LAUNCHER_URL = "https://github.com/mindstorm38/portablemc" diff --git a/portablemc/cli/lang.py b/portablemc/cli/lang.py index 397f292e..eb2091ca 100644 --- a/portablemc/cli/lang.py +++ b/portablemc/cli/lang.py @@ -89,7 +89,7 @@ def get(key: str, **kwargs) -> str: "args.start.version.comp.release": "Start the latest release (default).", "args.start.version.comp.snapshot": "Start the latest snapshot.", "args.start.version.comp.fabric": "Start Fabric mod loader with latest release.", - "args.start.version.comp.legacyfabric": "Start (Legacy)Fabric mod loader with latest release.", + "args.start.version.comp.legacyfabric": "Start LegacyFabric mod loader with latest release.", "args.start.version.comp.quilt": "Start Quilt mod loader with latest release.", "args.start.version.comp.forge": "Start Forge mod loader with latest release.", "args.start.version.comp.neoforge": "Start NeoForge mod loader with latest release.", diff --git a/pyproject.toml b/pyproject.toml index a1184aa1..2e54521b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "portablemc" -version = "4.2.1" +version = "4.3.0" description = "PortableMC is a module that provides both an API for development of your custom launcher and an executable script to run PortableMC CLI." authors = ["Théo Rozier "] license = "GPL-3.0-only"