99 lines
5.8 KiB
Markdown
99 lines
5.8 KiB
Markdown
<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"/>
|
|
</p>
|
|
<br>
|
|
|
|
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.
|
|
If you want to read about why this fork was created, check out [our FAQ page](https://polymc.org/wiki/overview/faq/).
|
|
<br>
|
|
|
|
# Installation
|
|
|
|
- All downloads and instructions for PolyMC can be found [here](https://polymc.org/download/)
|
|
- Last build status: https://github.com/PolyMC/PolyMC/actions
|
|
|
|
|
|
## 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.
|
|
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)
|
|
|
|
# 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)
|
|
|
|
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:matrix.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/#/#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/)
|
|
|
|
# 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 Instructions](https://polymc.org/wiki/development/build-instructions/) 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
|
|
|
|
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
|
|
|
|
## 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)
|
|
|
|
## Forking/Redistributing/Custom builds policy
|
|
|
|
We don't care what you do with your fork/custom build as long as you do the following as a basic courtesy:
|
|
- Follow the terms of the [license](LICENSE) (not just a courtesy, but also a legal responsibility)
|
|
- Make it clear that your fork is not PolyMC and is not endorsed by or affiliated with the PolyMC project (https://polymc.org).
|
|
- Go through [CMakeLists.txt](CMakeLists.txt) and change PolyMC's API keys to your own or set them to empty strings (`""`) to disable them (this way the program will still compile but the functionality requiring those keys will be disabled).
|
|
|
|
If you have any questions or want any clarification on the above conditions please make an issue and ask us.
|
|
|
|
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 by setting them to an empty string (`""`).
|
|
|
|
All launcher code is available under the GPL-3.0-only license.
|
|
|
|
The logo and related assets are under the CC BY-SA 4.0 license.
|