54 lines
2.2 KiB
Markdown
54 lines
2.2 KiB
Markdown
<p align="center">
|
|
<img src="https://avatars.githubusercontent.com/u/96310119" alt="PolyMC logo"/>
|
|
</p>
|
|
|
|
PolyMC 5
|
|
=========
|
|
|
|
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.
|
|
|
|
## todo
|
|
- [ ] Get a permanent name + icon.
|
|
- [ ] Style the logo for different icon styles.
|
|
- [ ] Packaging for Linux--Any help packaging for your favorite distro is appreciated!
|
|
- [ ] Packaging for MacOS/Windows
|
|
- [ ] Stop relying on MultiMC-Hosted metadata services
|
|
- [ ] Long-term solution for the MSA client ID issue
|
|
- [ ] Remove references to MultiMC
|
|
- [ ] Figure out a way to switch to GPL.
|
|
|
|
## Packages
|
|
We currently don't have any packages available yet as this project has just been started, but we expect this to change very soon.
|
|
|
|
## Development
|
|
If you want to contribute, talk to us on [Discord](https://discord.gg/multimc) first.
|
|
|
|
While blindly submitting PRs is definitely possible, they're not necessarily going to get accepted.
|
|
|
|
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.
|
|
|
|
### 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.
|
|
|
|
## Copyright
|
|
Copyright 2013-2021 MultiMC contributors
|
|
Copyright 2021 PolyMC contributors
|