Skip to content

Commit

Permalink
Updated README, update version to 4.3.0 and some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mindstorm38 committed Apr 21, 2024
1 parent ca535ae commit 4368a8e
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 12 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 `:<loader_version>`.
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 `:<loader_version>`. 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 `-<loader_version>`. Forge also supports `-latest` and `-recommended`, but NeoForge
will always take the latest loader.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion portablemc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"""

LAUNCHER_NAME = "portablemc"
LAUNCHER_VERSION = "4.2.1"
LAUNCHER_VERSION = "4.3.0"
LAUNCHER_AUTHORS = ["Théo Rozier <[email protected]>", "Contributors"]
LAUNCHER_COPYRIGHT = "PortableMC Copyright (C) 2021-2024 Théo Rozier"
LAUNCHER_URL = "https://github.com/mindstorm38/portablemc"
2 changes: 1 addition & 1 deletion portablemc/cli/lang.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"]
license = "GPL-3.0-only"
Expand Down

0 comments on commit 4368a8e

Please sign in to comment.