Sneederix/sneedmc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
f25a9bc103
sneedmc/README.md
swirl af76cf59b6
Move todo to wiki and update README 
Moved "todo" section to wiki

Reqorded packages section.

Changed swirl overlay URL to my Gitea instance

Added Flatpak and Debian package info

Serve packages over packages.polymc.org, and added SHA256 sums
2021-12-29 10:12:17 -05:00

4.5 KiB
Raw Blame History

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.

Packages

Several source build packages are available, along with experimental pre-built generic packages.

  • An AUR package is available.
  • A Gentoo ebuild is available in the swirl overlay, named games-action/polymc. Check the README for instructions on how to add the overlay.
  • A Flatpak is available. Instructions on building it can be found in [packages/flatpak/BUILDING.md](packages/flatpak/BUILDING.md).
  • Generic, prebuilt packages (archived by version) can be found here (latest)
  • Last build status: https://jenkins.polymc.org/job/PolyMC/lastBuild/
  • Linux (AMD64) System (SHA256) - this is a generic system package intended to be used as a base for making distro-specific packages.
  • Windows (32-bit) (SHA256) - this is a portable package, you can extract it anywhere and run it. This package needs testing.
  • Debian (AMD64 (SHA256) - this is intended to be installed with dpkg -i. Alternatively, you may build the .deb yourself, by going to packages/debian and running ./makedeb.sh.
  • MacOS currently does not have any packages. We are still working on setting up MacOS packaging.

Development

If you want to contribute to PolyMC you might find it useful to join #development:polymc.org on Matrix or join our Discord server, which is bridged with the PolyMC Matrix rooms. Thank you!

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.

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. Be sure to enable spaces first (Settings -> Labs -> Spaces), and then you may join the space:

PolyMC Space

Matrix's support for spaces is still in development, so if you have issues accessing rooms via the space, then you can join the rooms directly:

Support Discussion Development News