SneedMC

SneedMC is a sneedful launcher for Minecraft that focuses on sneedictability, long term sneedility, and sneedicity.

<<<<<<< HEAD

This is a fork of the MultiMC Launcher and not endorsed by MultiMC. If you want to read about why this fork was created, check out our FAQ page.

upstream/develop

Installation

• All downloads and instructions for PolyMC can be found here
• Last build status: https://github.com/PolyMC/PolyMC/actions

<<<<<<< HEAD

Cross-distro packages

• AppImage SHA256

Arch Linux

There are several AUR packages available:

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

Debian

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

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

Nix

A Nix derivation is available.

Gentoo

A Gentoo ebuild is available in the sneed overlay, named games-action/sneedmc.

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

Fedora

An RPM package is available on COPR.

sudo dnf copr enable polymc/polymc
sudo dnf install polymc

Slackware

A SlackBuild is available. You will need qt5 (on 15.0 installed by default), a JDK, and if you're on 14.2, you need to compile newer CMake version manually. To build, type in extracted directory with all dependiences met:

sudo ./polymc.SlackBuild
sudo installpkg /tmp/polymc-version-arch-1_SBo.tgz

If you are too lazy to do all these steps, you can just download a prebuild x86_64 package and install it with /sbin/installpkg:

sudo /sbin/installpkg ~/Downloads/polymc-version-x86_64-1_SBo.tgz

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.

FreeBSD

For FreeBSD available are:

• AppBSD Image - a portable application, requires AppBSD to be installed.

• Gzipped binaries - traditional way to distribute, unpack and run.

In both cases you need X11, Qt5 and Java installed. Both files are 64bit only.

OpenBSD

For OpenBSD available are gzipped 32-bit binaries, download, unpack and run.

You need X11, Qt5 and Java installed.

upstream/develop

Development Builds

There are per-commit development builds available here. These have debug information in the binaries, so their file sizes are relatively larger. Portable builds are provided for AppImage on Linux, Windows, and macOS.

For Debian and Arch, you can use these packages for the latest development versions:

For flatpak, you can use flathub-beta

Help & Support

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

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

<<<<<<< HEAD

upstream/develop

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:

We also have a subreddit you can post your issues and suggestions on:

r/PolyMCLauncher

Development

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

Building

<<<<<<< HEAD If you want to build SneedMC yourself, check BUILD.md for build instructions.

If you want to build PolyMC yourself, check Build Instructions for build instructions.

upstream/develop

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 SneedMC is hosted on Weblate and information about translating SneedMC is available at https://github.com/PolyMC/Translations

Download information

To modify download information or change packaging information send a pull request or issue to the website Here

Forking/Redistributing/Custom builds policy

<<<<<<< HEAD SNEED

We don't care what you do with your fork/custom build as long as you do the following as a basic courtesy:

• Follow the terms of the license (not just a courtesy, but also a legal responsibility)
• Make it clear that your fork is not PolyMC and is not endorsed by or affiliated with the PolyMC project (https://polymc.org).
• Go through CMakeLists.txt and change PolyMC's API keys to your own or set them to empty strings ("") to disable them (this way the program will still compile but the functionality requiring those keys will be disabled).

If you have any questions or want any clarification on the above conditions please make an issue and ask us.

Be aware that if you build this software without removing the provided API keys in CMakeLists.txt you are accepting the following terms and conditions:

• Microsoft Identity Platform Terms of Use
• CurseForge 3rd Party API Terms and Conditions

If you do not agree with these terms and conditions, then remove the associated API keys from the CMakeLists.txt file by setting them to an empty string ("").

All launcher code is available under the GPL-3.0-only license.

The logo and related assets are under the CC BY-SA 4.0 license.

Sponsors

Thank you to all our generous backers over at Open Collective! Support PolyMC by becoming a backer.

Also, thanks to JetBrains for providing us a few licenses for all their products, as part of their Open Source program.

Additionally, thanks to the awesome people over at MacStadium, for providing M1-Macs for development purposes!

upstream/develop