pollymc/README.md
2022-02-09 23:13:33 +00:00

6.7 KiB

PolyMC logo PolyMC logo


PolyMC is a custom launcher for Minecraft that focuses on predictability, long term stability and simplicity.

This is a fork of the MultiMC Launcher and not endorsed by MultiMC. The PolyMC community felt that the maintainer was not acting in the spirit of Free Software so this fork was made. Read "Why was this fork made?" on the wiki for more details.

Installation

🐧 Linux

Cross-distro packages

Download on Flathub

Download as AppImage

Arch Linux

There are several AUR packages available:

polymc polymc-bin polymc-git

# stable source package:
yay -S polymc
# stable binary package:
yay -S polymc-bin
# latest git package:
yay -S polymc-git

Debian

We use makedeb for our Debian packages. Several MPR packages are available:

polymc polymc-bin polymc-git

# stable source package:
sudo tap install polymc
# stable binary package:
sudo tap install polymc-bin
# latest git package:
sudo tap install polymc-git

Nix

A Nix derivation is available.

Gentoo

A Gentoo ebuild is available in the swirl overlay, named games-action/polymc.

# as root:
emerge --oneshot eselect-repository
eselect repository enable swirl
emaint sync -r swirl
emerge polymc
# to use latest git version:
sudo tee -a /etc/portage/package.accept_keywords <<< "=games-action/polymc-9999 **"

Fedora

An RPM package is available on COPR.

sudo dnf copr enable polymc/polymc
sudo dnf install polymc

Alternatively, a COPR maintained by a PolyMC user (instead of Jenkins' automated builds) is available here.

sudo dnf copr enable sentry/polymc
sudo dnf install polymc

Windows

Windows (32-bit) (SHA256) - this is a portable package, you can extract it anywhere and run it. This package needs testing.

MacOS

MacOS currently does not have any packages. We are still working on setting up MacOS packaging. Meanwhile, you can build it for yourself.

Help & Support

Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server.

PolyMC Discord

For people who don't want to use Discord, we have a Matrix Space which is bridged to the Discord server:

PolyMC Space

If there are any issues with the space or you are using a client that does not support the feature here are the individual rooms:

Support Discussion Development News

Development

If you want to contribute to PolyMC you might find it useful to join our Discord Server or Matrix Space.

Building

If you want to build PolyMC yourself, check BUILD.md for build instructions.

Code formatting

Just follow the existing formatting.

In general, in order of importance:

  • Make sure your IDE is not messing up line endings or whitespace and avoid using linters.
  • Prefer readability over dogma.
  • Keep to the existing formatting.
  • Indent with 4 space unless it's in a submodule.
  • Keep lists (of arguments, parameters, initializers...) as lists, not paragraphs. It should either read from top to bottom, or left to right. Not both.

Translations

The translation effort for PolyMC is hosted on Weblate and information about translating PolyMC is available at https://github.com/PolyMC/Translations

Forking/Redistributing/Custom builds policy

Do whatever you want, we don't care. Just follow the license. If you have any questions about this feel free to ask in an issue.