118 lines
4.2 KiB
Markdown
118 lines
4.2 KiB
Markdown
<p align="center">
|
|
<img src="./program_info/org.sneederix.SneedMC.svg" alt="SneedMC logo"/>
|
|
</p>
|
|
|
|
# SneedMC
|
|
|
|
SneedMC is a sneedful launcher for Minecraft that focuses on sneedictability, long term sneedility, and sneedicity.
|
|
|
|
<br>
|
|
|
|
# Installation
|
|
|
|
TODO: Create SneedMC-Dev and add portable build.
|
|
|
|
- Prebuilt packages for SneedMC can be found [here](https://packages.sneedmc.org/)
|
|
- Build instructions can be found in [BUILD.md](BUILD.md)
|
|
- Last build status: https://jenkins.swurl.xyz/jobs/SneedMC
|
|
|
|
### <img src="https://www.vectorlogo.zone/logos/linuxfoundation/linuxfoundation-icon.svg" height="20" alt=""/> Cross-distro packages
|
|
|
|
<a href="https://packages.sneedmc.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.sneedmc.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:
|
|
|
|
TODO: I should make these.
|
|
|
|
[](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/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
|
|
|
|
TODO: Create this overlay.
|
|
|
|
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
|
|
|
|
TODO: Create this COPR.
|
|
|
|
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://www.vectorlogo.zone/logos/microsoft/microsoft-icon.svg" height="20" /> Windows
|
|
|
|
[Windows (32-bit)](https://packages.sneedmc.org/latest/win32/win32.zip) ([SHA256](https://packages.sneedmc.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.
|
|
|
|
## Development Builds
|
|
|
|
TODO: Add SneedMC-Dev.
|
|
|
|
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 Arch, you can use this package for the latest development versions:
|
|
[](https://aur.archlinux.org/packages/polymc-git/)
|
|
|
|
For flatpak, you can use [flathub-beta](https://discourse.flathub.org/t/how-to-use-flathub-beta/2111)
|
|
|
|
# Help & Support
|
|
|
|
Use the issue tracker.
|
|
|
|
# Development
|
|
|
|
If you want to contribute to SneedMC you might find it useful to sneethe.
|
|
|
|
## Building
|
|
|
|
If you want to build SneedMC yourself, check [BUILD.md](BUILD.md) for build instructions.
|
|
|
|
## 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
|
|
|
|
## Forking/Redistributing/Custom builds policy
|
|
|
|
SNEED
|
|
|
|
## Sponsors
|
|
|
|
Money is not sneedful
|