2017-08-27 12:56:21 +02:00
< p align = "center" >
2022-01-19 18:59:24 +01:00
< 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 12:56:21 +02:00
< / p >
2022-01-09 15:13:15 +10:00
< br >
2022-01-15 21:25:49 -05:00
2021-12-13 13:01:29 -05:00
PolyMC is a custom launcher for Minecraft that focuses on predictability, long term stability and simplicity.
2022-04-21 22:52:05 +02:00
This is a **fork** of the MultiMC Launcher and not endorsed by MultiMC.
If you want to read about why this fork was created, check out [our FAQ page ](https://polymc.org/wiki/overview/faq/ ).
2022-01-27 13:46:58 +01:00
< br >
# Installation
2022-03-01 23:19:30 +10:00
- All downloads and instructions for PolyMC can be found [here ](https://polymc.org/download/ )
- Last build status: https://github.com/PolyMC/PolyMC/actions
2022-02-18 10:28:17 +01:00
2022-02-05 16:03:16 +01:00
2022-02-16 18:31:34 +01:00
## 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.
2022-02-17 11:46:34 +01:00
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 )
2022-02-16 18:31:34 +01:00
2022-01-27 13:46:58 +01:00
# Help & Support
2019-11-27 00:35:42 +01:00
2021-12-26 16:01:29 -05:00
Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server.
2021-12-24 14:28:54 -05:00
2021-12-26 16:01:29 -05:00
[](https://discord.gg/xq7fxrgtMP)
2021-12-24 14:28:54 -05:00
2022-01-09 15:13:15 +10:00
For people who don't want to use Discord, we have a Matrix Space which is bridged to the Discord server:
2021-12-24 14:28:54 -05:00
2022-04-03 20:37:50 +10:00
[](https://matrix.to/#/#polymc:matrix .org)
2021-12-24 14:28:54 -05:00
2022-01-09 15:13:15 +10:00
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:
2021-12-24 14:28:54 -05:00
2022-04-03 20:37:50 +10:00
[](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/ )
2022-01-27 13:46:58 +01:00
# Development
If you want to contribute to PolyMC you might find it useful to join our Discord Server or Matrix Space.
## Building
2022-03-08 19:07:21 +10:00
If you want to build PolyMC yourself, check [Build Instructions ](https://polymc.org/wiki/development/build-instructions/ ) for build instructions.
2022-01-27 13:46:58 +01:00
## Code formatting
2022-02-17 11:46:34 +01:00
2022-01-27 13:46:58 +01:00
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
2022-02-09 21:40:57 -06:00
The translation effort for PolyMC is hosted on [Weblate ](https://hosted.weblate.org/projects/polymc/polymc/ ) and information about translating PolyMC is available at https://github.com/PolyMC/Translations
2022-01-27 13:46:58 +01:00
2022-03-13 23:25:17 +10:00
## 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 )
2022-03-01 10:33:59 +10:00
2022-01-27 13:46:58 +01:00
## 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.
2022-03-08 19:07:21 +10:00
2022-05-28 12:07:01 +02:00
Be aware that if you build this software without removing the provided API keys in [CMakeLists.txt ](CMakeLists.txt ) you are accepting the following terms and conditions:
- [Microsoft Identity Platform Terms of Use ](https://docs.microsoft.com/en-us/legal/microsoft-identity-platform/terms-of-use )
- [CurseForge 3rd Party API Terms and Conditions ](https://support.curseforge.com/en/support/solutions/articles/9000207405-curse-forge-3rd-party-api-terms-and-conditions )
If you do not agree with these terms and conditions, then remove the associated API keys from the [CMakeLists.txt ](CMakeLists.txt ) file.
2022-04-21 22:52:05 +02:00
All launcher code is available under the GPL-3.0-only license.
2022-03-08 19:07:21 +10:00
2022-04-02 17:25:49 +10:00
The logo and related assets are under the CC BY-SA 4.0 license.
