pollymc/README.md

162 lines
7.7 KiB
Markdown
Raw Normal View History

2017-08-27 16:26:21 +05:30
<p align="center">
<img src="./program_info/polymc-header-black.svg#gh-light-mode-only" alt="PolyMC logo"/>
<img src="./program_info/polymc-header.svg#gh-dark-mode-only" alt="PolyMC logo"/>
2017-08-27 16:26:21 +05:30
</p>
<br>
2022-01-16 07:55:49 +05:30
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.
2022-01-27 18:16:58 +05:30
<br>
# Installation
2022-01-31 20:30:25 +05:30
- 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/
2022-01-27 18:16:58 +05:30
## 🐧 Linux
2022-01-27 18:16:58 +05:30
### <img src="https://www.vectorlogo.zone/logos/linuxfoundation/linuxfoundation-icon.svg" height="20" alt=""/> Cross-distro packages
2021-12-21 07:28:36 +05:30
<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>
2022-01-27 18:16:58 +05:30
<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)
2022-01-31 20:30:25 +05:30
2022-01-27 18:16:58 +05:30
### <img src="https://www.vectorlogo.zone/logos/archlinux/archlinux-icon.svg" height="20"/> Arch Linux
2022-01-31 20:30:25 +05:30
There are several AUR packages available:
2022-02-03 23:17:16 +05:30
2022-01-31 20:30:25 +05:30
[![polymc](https://img.shields.io/badge/aur-polymc-blue)](https://aur.archlinux.org/packages/polymc/)
[![polymc-bin](https://img.shields.io/badge/aur-polymc--bin-blue)](https://aur.archlinux.org/packages/polymc-bin/)
2022-01-29 13:26:04 +05:30
[![polymc-git](https://img.shields.io/badge/aur-polymc--git-blue)](https://aur.archlinux.org/packages/polymc-git/)
2022-01-27 18:16:58 +05:30
```sh
2022-01-29 13:26:04 +05:30
# stable source package:
2022-01-27 18:16:58 +05:30
yay -S polymc
# stable binary package:
yay -S polymc-bin
# latest git package:
yay -S polymc-git
```
2015-11-09 04:57:57 +05:30
2022-01-27 18:16:58 +05:30
### <img src="https://www.vectorlogo.zone/logos/debian/debian-icon.svg" height="20" /> Debian
2022-01-31 20:30:25 +05:30
We use [makedeb](https://docs.makedeb.org/) for our Debian packages.
2022-01-29 13:26:04 +05:30
Several MPR packages are available:
2022-01-31 20:30:25 +05:30
[![polymc](https://img.shields.io/badge/mpr-polymc-orange)](https://mpr.makedeb.org/packages/polymc)
[![polymc-bin](https://img.shields.io/badge/mpr-polymc--bin-orange)](https://mpr.makedeb.org/packages/polymc-bin)
2022-01-29 14:10:27 +05:30
[![polymc-git](https://img.shields.io/badge/mpr-polymc--git-orange)](https://mpr.makedeb.org/packages/polymc-git)
2015-11-09 04:57:57 +05:30
2022-01-27 18:16:58 +05:30
```sh
2022-01-29 13:26:04 +05:30
# stable source package:
sudo tap install polymc
# stable binary package:
sudo tap install polymc-bin
2022-01-29 14:10:27 +05:30
# latest git package:
sudo tap install polymc-git
2022-01-27 18:16:58 +05:30
```
2013-12-30 19:54:18 +05:30
2022-01-27 18:16:58 +05:30
### <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
2022-01-28 13:42:55 +05:30
A Gentoo ebuild is available in the [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`.
```sh
2022-01-29 13:26:04 +05:30
# as root:
2022-01-28 13:42:55 +05:30
emerge --oneshot eselect-repository
eselect repository enable swirl
2022-01-28 13:42:55 +05:30
emaint sync -r swirl
emerge polymc
# to use latest git version:
2022-01-29 13:26:04 +05:30
sudo tee -a /etc/portage/package.accept_keywords <<< "=games-action/polymc-9999 **"
2022-01-28 13:42:55 +05:30
```
2022-01-27 18:16:58 +05:30
### <img src="https://www.vectorlogo.zone/logos/getfedora/getfedora-icon.svg" height="20"> Fedora
2022-01-31 23:05:30 +05:30
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
```
Alternatively, a COPR maintained by a PolyMC user (instead of Jenkins' automated builds) is available [here](https://copr.fedorainfracloud.org/coprs/sentry/polymc).
2022-01-27 18:16:58 +05:30
```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
2022-01-29 22:40:46 +05:30
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.
2022-01-27 18:16:58 +05:30
2022-02-04 22:29:37 +05:30
## <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.
If you are too lazy to do all these steps, you can just download [a prebuild x86_64 package](https://codeberg.org/attachments/0547129b-3910-4b46-89fb-50b3221576b1) and install it with /sbin/installpkg.
## <img src="https://www.vectorlogo.zone/logos/freebsd/freebsd-icon.svg" height="20" /> FreeBSD
2022-02-04 22:42:32 +05:30
For FreeBSD available are:
-[AppBSD Image](https://drive.google.com/file/d/1QLYWGkLSjVb8-lhICivozZQDwYEWBack/view?usp=sharing) - a portable application, requires [AppBSD](https://codeberg.org/glowiak/appbsd/) to be installed.
-[Gzipped binaries](https://codeberg.org/attachments/7aa74368-1f55-49be-abd8-0b8258e63e38) - traditional way to distribute, unpack and run.
In both cases you need X11, Qt5 and Java installed
2022-01-27 18:16:58 +05:30
# 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](https://img.shields.io/discord/923671181020766230?label=PolyMC%20Discord)](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:
[![PolyMC Space](https://img.shields.io/matrix/polymc:polymc.org?label=PolyMC%20Space&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#polymc:polymc.org)
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:
[![Support](https://img.shields.io/matrix/support:polymc.org?label=%23support&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#support:polymc.org)
[![Discussion](https://img.shields.io/matrix/discussion:polymc.org?label=%23discussion&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#discussion:polymc.org)
[![Development](https://img.shields.io/matrix/development:polymc.org?label=%23development&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#development:polymc.org)
[![News](https://img.shields.io/matrix/news:polymc.org?label=%23news&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#news:polymc.org)
2022-01-27 18:16:58 +05:30
# 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.