pollymc/README.md
2021-12-20 20:58:36 -05:00

2.3 KiB

PolyMC logo

PolyMC 5

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.

todo

  • Get a permanent name + icon.
  • Style the logo for different icon styles.
  • Packaging for Linux--Any help packaging for your favorite distro is appreciated!
  • Packaging for MacOS/Windows
  • Stop relying on MultiMC-Hosted metadata services
  • Remove references to MultiMC
  • Meson
  • Long-term solution for the MSA client ID issue
  • Figure out a way to switch to GPL.

Packages

Experimental packages are available for Linux (non-portable) and Windows (portable). The Linux version is confirmed to work, but the Windows version needs testing. Please volunteer to help us if you use Windows!

  • Linux (AMD64) - this is a SYSTEM package and is NOT intended to be portable!
  • Windows (64-bit) - this is a PORTABLE package. This package needs testing.

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

TODO

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.

Copyright 2013-2021 MultiMC contributors Copyright 2021 PolyMC contributors