diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 127 |
1 files changed, 94 insertions, 33 deletions
@@ -7,51 +7,84 @@ 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?](https://github.com/PolyMC/PolyMC/wiki/FAQ)" on the wiki for more details. +<br> + +# Installation + +## 🐧 Linux -## Packages -Several source build packages are available, along with experimental pre-built generic packages. +### <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> -<br> -[](https://aur.archlinux.org/packages/polymc-git/) -- A [Nix](packages/nix/NIX.md) derivation is available in repo. -- A Gentoo ebuild is available in the [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`. Check the README for instructions on how to add the overlay. -- The Flatpak can be built using [this source](https://github.com/flathub/org.polymc.PolyMC). -- An RPM package is available on [COPR](https://copr.fedorainfracloud.org/coprs/sentry/polymc/), or can be built by going to the `packages/rpm` directory and running `rpmbuild -bb polymc.spec`. -- Generic, prebuilt packages (archived by version) can be found [here](https://packages.polymc.org/) ([latest](https://packages.polymc.org/latest)). + +<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) +- All packages (archived by version) can be found [here](https://packages.polymc.org/) ([latest](https://packages.polymc.org/latest)). - Last build status: https://jenkins.polymc.org/job/PolyMC/lastBuild/ -- [Linux (AMD64) System](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst) ([SHA256](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst.sha256)) - this is a generic system package intended to be used as a base for making distro-specific packages. -- [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. -- [Debian (AMD64)](https://packages.polymc.org/latest/deb/polymc-amd64.deb) ([SHA256](https://packages.polymc.org/latest/deb/polymc-amd64.deb.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`. -- [AppImage (AMD64)](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage) ([SHA256](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage.sha256)) - `chmod +x` must be run on this file before usage. This should work on any distribution. -- [Arch Linux (AMD64)](https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst) ([SHA256](https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst.sha256)) - this is intended to be installed with `pacman -U`. This is an alternative if building the AUR package is not desired. -- MacOS currently does not have any packages. We are still working on setting up MacOS packaging. +- [System Package (AMD64)](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst) ([SHA256](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst.sha256)) - a generic system package intended to be used as a base for making distro-specific packages -## Development -If you want to contribute to PolyMC you might find it useful to join [#development:polymc.org on Matrix](https://matrix.to/#/#development:polymc.org) or join [our Discord server](https://discord.gg/xq7fxrgtMP), which is bridged with the PolyMC Matrix rooms. Thank you! +### <img src="https://www.vectorlogo.zone/logos/archlinux/archlinux-icon.svg" height="20"/> Arch Linux -### Building -If you want to build PolyMC yourself, check [BUILD.md](BUILD.md) for build instructions. +There are several AUR packages available: +[](https://aur.archlinux.org/packages/polymc/) +[](https://aur.archlinux.org/packages/polymc-bin/) +[](https://aur.archlinux.org/packages/polymc-git/) -You can build the flatpak using [this source](https://github.com/flathub/org.polymc.PolyMC). +```sh +# stable source package +yay -S polymc +# stable binary package: +yay -S polymc-bin +# latest git package: +yay -S polymc-git +``` -### Code formatting -Just follow the existing formatting. +A prebuilt Arch package is available: +[Arch Linux (AMD64)](https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst) ([SHA256](https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst.sha256)) -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. +``` +wget https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst +sudo pacman -U polymc-bin-latest-1-x86_64.pkg.tar.zst +``` -## Translations -TODO +### <img src="https://www.vectorlogo.zone/logos/debian/debian-icon.svg" height="20" /> Debian -## 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. +A prebuilt deb package is available: +[Debian (AMD64)](https://packages.polymc.org/latest/deb/polymc-amd64.deb) ([SHA256](https://packages.polymc.org/latest/deb/polymc-amd64.deb.sha256)) + +```sh +wget https://packages.polymc.org/latest/deb/polymc-amd64.deb +sudo apt install ./polymc-amd64.deb +``` + +### <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 [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`. Check the README for instructions on how to add the overlay. + +### <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/sentry/polymc/) + +```sh +sudo dnf copr enable sentry/polymc +sudo dnf install polymc +``` + +## <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. + +# Help & Support -## 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) @@ -66,3 +99,31 @@ If there are any issues with the space or you are using a client that does not s [](https://matrix.to/#/#discussion:polymc.org) [](https://matrix.to/#/#development:polymc.org) [](https://matrix.to/#/#news:polymc.org) + +# Development + +If you want to contribute to PolyMC you might find it useful to join our Discord Server or Matrix Space. + +## Building + +If you want to build PolyMC 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 + +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. |