191 lines
9.4 KiB
Markdown
191 lines
9.4 KiB
Markdown
<p align="center">
|
|
<img src="./program_info/org.sneederix.SneedMC.svg" alt="SneedMC logo"/>
|
|
</p>
|
|
<br>
|
|
|
|
# SneedMC
|
|
|
|
SneedMC is a sneedful launcher for Minecraft that focuses on sneedictability, long term sneedility, and sneedicity.
|
|
|
|
<br>
|
|
|
|
# Installation
|
|
|
|
- All downloads and instructions for PolyMC can be found [here](https://polymc.org/download/)
|
|
- Last build status: https://github.com/PolyMC/PolyMC/actions
|
|
|
|
### <img src="https://www.vectorlogo.zone/logos/linuxfoundation/linuxfoundation-icon.svg" height="20" alt=""/> Cross-distro packages
|
|
|
|
<a href='https://flathub.org/apps/details/org.polymc.PolyMC'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
|
|
|
|
<a href="https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage"><img src="https://docs.appimage.org/_images/download-appimage-banner.svg" width="240" alt="Download as AppImage" /></a>
|
|
|
|
- [AppImage SHA256](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage.sha256)
|
|
|
|
### <img src="https://www.vectorlogo.zone/logos/archlinux/archlinux-icon.svg" height="20"/> Arch Linux
|
|
|
|
There are several AUR packages available:
|
|
|
|
[](https://aur.archlinux.org/packages/sneedmc/)
|
|
[](https://aur.archlinux.org/packages/sneedmc-bin/)
|
|
[](https://aur.archlinux.org/packages/sneedmc-git/)
|
|
|
|
```sh
|
|
# stable source package:
|
|
yay -S sneedmc
|
|
# stable binary package:
|
|
yay -S sneedmc-bin
|
|
# latest git package:
|
|
yay -S sneedmc-git
|
|
```
|
|
|
|
### <img src="https://www.vectorlogo.zone/logos/debian/debian-icon.svg" height="20" /> Debian
|
|
|
|
We use [makedeb](https://docs.makedeb.org/) for our Debian packages.
|
|
Several MPR packages are available:
|
|
|
|
[](https://mpr.makedeb.org/packages/sneedmc)
|
|
[](https://mpr.makedeb.org/packages/sneedmc-bin)
|
|
[](https://mpr.makedeb.org/packages/sneedmc-git)
|
|
|
|
```sh
|
|
# stable source package:
|
|
sudo tap install sneedmc
|
|
# stable binary package:
|
|
sudo tap install sneedmc-bin
|
|
# latest git package:
|
|
sudo tap install sneedmc-git
|
|
```
|
|
|
|
### <img src="https://www.vectorlogo.zone/logos/nixos/nixos-icon.svg" height="20" /> Nix
|
|
|
|
A [Nix derivation](packages/nix/NIX.md) is available.
|
|
|
|
### <img src="https://www.gentoo.org/assets/img/logo/gentoo-signet.svg" height="20" /> Gentoo
|
|
|
|
A Gentoo ebuild is available in the [sneed](https://git.swurl.xyz/Sneederix/overlay) overlay, named `games-action/sneedmc`.
|
|
|
|
```sh
|
|
# 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 **"
|
|
```
|
|
|
|
### <img src="https://www.vectorlogo.zone/logos/getfedora/getfedora-icon.svg" height="20"> Fedora
|
|
|
|
An RPM package is available on [COPR](https://copr.fedorainfracloud.org/coprs/polymc/polymc/).
|
|
|
|
```sh
|
|
sudo dnf copr enable polymc/polymc
|
|
sudo dnf install polymc
|
|
```
|
|
|
|
### <img src="https://lotar.altervista.org/wiki/_media/news/slackware-logo.png" height="20" /> Slackware
|
|
|
|
[A SlackBuild](https://codeberg.org/glowiak/SlackBuilds/src/branch/master/repository/polymc.md) is available. You will need [qt5](http://slackbuilds.org/repository/14.2/libraries/qt5/) (on 15.0 installed by default), [a JDK](https://codeberg.org/glowiak/SlackBuilds/src/branch/master/repository/adoptium-jdk8.md), 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](http://glowiak.github.io/file/polymc-latest-slackware) and install it with /sbin/installpkg:
|
|
|
|
sudo /sbin/installpkg ~/Downloads/polymc-version-x86_64-1_SBo.tgz
|
|
|
|
## <img src="https://www.vectorlogo.zone/logos/microsoft/microsoft-icon.svg" height="20" /> Windows
|
|
|
|
[Windows (32-bit)](https://packages.polymc.org/latest/win32/win32.zip) ([SHA256](https://packages.polymc.org/latest/win32/win32.zip.sha256)) - this is a portable package, you can extract it anywhere and run it. This package needs testing.
|
|
|
|
## <img src="https://www.vectorlogo.zone/logos/apple/apple-tile.svg" height="20" /> MacOS
|
|
|
|
MacOS currently does not have any packages. We are still working on setting up MacOS packaging. Meanwhile, you can [build](https://github.com/PolyMC/PolyMC/blob/develop/BUILD.md#macos) it for yourself.
|
|
|
|
## <img src="https://www.vectorlogo.zone/logos/freebsd/freebsd-icon.svg" height="20" /> FreeBSD
|
|
|
|
For FreeBSD available are:
|
|
|
|
- [AppBSD Image](http://glowiak.github.io/file/polymc-latest-fbsd64-appbsd) - a portable application, requires [AppBSD](https://codeberg.org/glowiak/appbsd/) to be installed.
|
|
|
|
- [Gzipped binaries](http://glowiak.github.io/file/polymc-latest-fbsd64-raw) - traditional way to distribute, unpack and run.
|
|
|
|
In both cases you need X11, Qt5 and Java installed. Both files are 64bit only.
|
|
|
|
## <img src="https://raw.githubusercontent.com/AliasIO/wappalyzer/master/src/drivers/webextension/images/icons/OpenBSD%20httpd.svg" height="20" /> OpenBSD
|
|
|
|
For OpenBSD available are [gzipped 32-bit binaries](http://glowiak.github.io/file/polymc-latest-obsd32-raw), download, unpack and run.
|
|
|
|
You need X11, Qt5 and Java installed.
|
|
|
|
## Development Builds
|
|
|
|
There are per-commit development builds available [here](https://github.com/PolyMC/PolyMC/actions). 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:
|
|
[](https://aur.archlinux.org/packages/polymc-git/)
|
|
[](https://mpr.makedeb.org/packages/polymc-git)
|
|
For flatpak, you can use [flathub-beta](https://discourse.flathub.org/t/how-to-use-flathub-beta/2111)
|
|
|
|
# Help & Support
|
|
|
|
Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server.
|
|
|
|
[](https://discord.gg/xq7fxrgtMP)
|
|
|
|
For people who don't want to use Discord, we have a Matrix Space which is bridged to the Discord server:
|
|
|
|
<<<<<<< HEAD
|
|
[](https://matrix.to/#/#polymc:polymc.org)
|
|
=======
|
|
[](https://matrix.to/#/#polymc:matrix.org)
|
|
>>>>>>> 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:
|
|
|
|
[](https://matrix.to/#/#polymc-development:matrix.org)
|
|
[](https://matrix.to/#/#polymc-discussion:matrix.org)
|
|
[](https://matrix.to/#/#polymc-github:matrix.org)
|
|
[](https://matrix.to/#/#polymc-maintainers:matrix.org)
|
|
[](https://matrix.to/#/#polymc-news:matrix.org)
|
|
[](https://matrix.to/#/#polymc-offtopic:matrix.org)
|
|
[](https://matrix.to/#/#polymc-support:matrix.org)
|
|
[](https://matrix.to/#/#polymc-voice:matrix.org)
|
|
|
|
We also have a subreddit you can post your issues and suggestions on:
|
|
|
|
[r/PolyMCLauncher](https://www.reddit.com/r/PolyMCLauncher/)
|
|
|
|
# Development
|
|
|
|
If you want to contribute to SneedMC you might find it useful to join our Discord Server or Matrix Space.
|
|
|
|
## Building
|
|
|
|
If you want to build SneedMC yourself, check [BUILD.md](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 SneedMC is hosted on [Weblate](https://hosted.weblate.org/projects/polymc/polymc/) 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](https://github.com/PolyMC/polymc.github.io/blob/master/src/download.md)
|
|
|
|
## Forking/Redistributing/Custom builds policy
|
|
|
|
SNEED
|