diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 157 |
1 files changed, 124 insertions, 33 deletions
@@ -1,53 +1,144 @@ <p align="center"> - <img src="https://avatars2.githubusercontent.com/u/5411890" alt="MultiMC logo"/> + <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"/> </p> +<br> -MultiMC -======= +PolyMC is a custom launcher for Minecraft that focuses on predictability, long term stability and simplicity. -MultiMC 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> -## Development -If you want to contribute, talk to us on [Discord](https://discord.gg/multimc) first. +# Installation +- 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/ -While blindly submitting PRs is definitely possible, they're not necessarily going to get accepted. +## 🐧 Linux -We aren't looking for flashy features, but expanding upon the existing feature set without distruption or endangering future viability of the project is OK. +### <img src="https://www.vectorlogo.zone/logos/linuxfoundation/linuxfoundation-icon.svg" height="20" alt=""/> Cross-distro packages -### Building -If you want to build the launcher yourself, check [BUILD.md](BUILD.md) for build instructions. +<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> -### Code formatting -Just follow the existing formatting. +<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> -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. +- [AppImage SHA256](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage.sha256) -## Translations -Translations can be done [on crowdin](https://translate.multimc.org). Please avoid making direct pull requests to the translations repository. +### <img src="https://www.vectorlogo.zone/logos/archlinux/archlinux-icon.svg" height="20"/> Arch Linux -## License -Copyright © 2013-2022 MultiMC Contributors +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/) -Licensed under the Apache License, Version 2.0 (the "License"); you may not use this program except in compliance with the License. You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0). +```sh +# stable source package: +yay -S polymc +# stable binary package: +yay -S polymc-bin +# latest git package: +yay -S polymc-git +``` -Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +### <img src="https://www.vectorlogo.zone/logos/debian/debian-icon.svg" height="20" /> Debian -## Forking/Redistributing/Custom builds policy -We keep Launcher open source because we think it's important to be able to see the source code for a project like this, and we do so using the Apache license. +We use [makedeb](https://docs.makedeb.org/) for our Debian packages. +Several MPR packages are available: + +[](https://mpr.makedeb.org/packages/polymc) +[](https://mpr.makedeb.org/packages/polymc-bin) +[](https://mpr.makedeb.org/packages/polymc-git) + +```sh +# stable source package: +sudo tap install polymc +# stable binary package: +sudo tap install polymc-bin +# latest git package: +sudo tap install polymc-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 [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`. + +```sh +# as root: +emerge --oneshot eselect-repository +eselect repository enable swirl +emaint sync -r swirl +emerge polymc +# to use latest git version: +sudo tee -a /etc/portage/package.accept_keywords <<< "=games-action/polymc-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 +``` + +Alternatively, a COPR maintained by a PolyMC user (instead of Jenkins' automated builds) is available [here](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 -The license gives you access to the source MultiMC is build from, but: -- Not the name, logo and other branding. -- Not the API tokens required to talk to services the launcher depends on. +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. -Because of the nature of the agreements required to interact with the Microsoft identity platform, it's impossible for us to continue allowing everyone to build the code as 'MultiMC'. The source code has been debranded and now builds as `DevLauncher` by default. +# Help & Support -You must provide your own branding if you want to distribute your own builds. +Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server. -You will also have to register your own app on Azure to be able to handle Microsoft account logins. +[](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: + +[](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: + +[](https://matrix.to/#/#support:polymc.org) +[](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 -If you decide to fork the project, a mention of its origins in the About dialog and the license is acceptable. However, it should be abundantly clear that the project is a fork *without* implying that you have our blessing. +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. |