pollymc/README.md

<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
- [ ] Remove references to MultiMC
- [ ] Meson
- [x] Long-term solution for the MSA client ID issue
- [x] Figure out a way to switch to GPL.

## Packages
Experimental packages are available for Linux (non-portable) and Windows (portable). Both versions are confirmed to work but the Windows version needs more testing--please volunteer if you use Windows!

- A full list of packages is available [here](https://jenkins.swurl.xyz/job/PolyMC/lastSuccessfulBuild/artifact/).
- Last build status: https://jenkins.swurl.xyz/job/PolyMC/lastBuild/
- [Linux (AMD64) System](https://jenkins.swurl.xyz/job/PolyMC/lastSuccessfulBuild/artifact/lin64-system.tar.zst) - this is a SYSTEM package that is intended to be installed via a package manager. This CAN NOT be used as a portable application!
- [Windows (32-bit)](https://jenkins.swurl.xyz/job/PolyMC/lastSuccessfulBuild/artifact/win32.zip) - this is a PORTABLE package. This package needs testing.
- MacOS currently does not have any packages. We are still working on setting up MacOS packaging.

### 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
NOISSUE update te logo in the README 2017-08-27 16:26:21 +05:30			`<p align="center">`
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30			`<img src="https://avatars.githubusercontent.com/u/96310119" alt="PolyMC logo"/>`
NOISSUE update te logo in the README 2017-08-27 16:26:21 +05:30			`</p>`
Added readme 2013-01-10 00:28:33 +05:30
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30			`PolyMC 5`
Add build instructions, markdown-ify README.md 2013-09-23 00:30:58 +05:30			`=========`

Fix README and some references to MultiMC. 2021-12-13 23:31:29 +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.`

			`## 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`
			`- [ ] Remove references to MultiMC`
add Meson to todo 2021-12-18 21:59:24 +05:30			`- [ ] Meson`
Move MSA Client ID to the same place as the others MSA Client ID has been moved to CMakeLists.txt, and defaults to the Client ID for the PolyMC application. Removed secrets/notsecrets library, replace with (temporary?) program_info subdirectory. 2021-12-20 08:11:08 +05:30			`- [x] Long-term solution for the MSA client ID issue`
update README.md update todo section temporarily remove development section until we set up a community hub 2021-12-18 20:36:01 +05:30			`- [x] Figure out a way to switch to GPL.`
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30
			`## Packages`
update packages (win64 -> win32) 2021-12-23 02:10:45 +05:30			`Experimental packages are available for Linux (non-portable) and Windows (portable). Both versions are confirmed to work but the Windows version needs more testing--please volunteer if you use Windows!`
packages on README 2021-12-21 07:28:36 +05:30
update packages (win64 -> win32) 2021-12-23 02:10:45 +05:30			`- A full list of packages is available [here](https://jenkins.swurl.xyz/job/PolyMC/lastSuccessfulBuild/artifact/).`
			`- Last build status: https://jenkins.swurl.xyz/job/PolyMC/lastBuild/`
			`- [Linux (AMD64) System](https://jenkins.swurl.xyz/job/PolyMC/lastSuccessfulBuild/artifact/lin64-system.tar.zst) - this is a SYSTEM package that is intended to be installed via a package manager. This CAN NOT be used as a portable application!`
			`- [Windows (32-bit)](https://jenkins.swurl.xyz/job/PolyMC/lastSuccessfulBuild/artifact/win32.zip) - this is a PORTABLE package. This package needs testing.`
			`- MacOS currently does not have any packages. We are still working on setting up MacOS packaging.`
Add build instructions, markdown-ify README.md 2013-09-23 00:30:58 +05:30
NOISSUE reword and reformat the README 2015-11-09 04:57:57 +05:30			`### Building`
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30			`If you want to build PolyMC yourself, check [BUILD.md](BUILD.md) for build instructions.`
NOISSUE reword and reformat the README 2015-11-09 04:57:57 +05:30
			`### Code formatting`
NOISSUE correct some parts of the README, one more translation string change 2019-09-26 12:33:25 +05:30			`Just follow the existing formatting.`

NOISSUE update README.md It has not been touched in a long time. This brings it a bit more up to date. 2021-08-29 05:42:09 +05:30			`In general, in order of importance:`
			`* Make sure your IDE is not messing up line endings or whitespace and avoid using linters.`
NOISSUE correct some parts of the README, one more translation string change 2019-09-26 12:33:25 +05:30			`* Prefer readability over dogma.`
NOISSUE update README.md It has not been touched in a long time. This brings it a bit more up to date. 2021-08-29 05:42:09 +05:30			`* 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.`
NOISSUE reword and reformat the README 2015-11-09 04:57:57 +05:30
			`## Translations`
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30			`TODO`
Clarify code style for contributions 2013-12-30 19:54:18 +05:30
NOISSUE update README.md It has not been touched in a long time. This brings it a bit more up to date. 2021-08-29 05:42:09 +05:30			`## Forking/Redistributing/Custom builds policy`
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30			`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.`
NOISSUE Attempt to add build status and test teamcity build reporting 2019-11-27 05:05:42 +05:30
Fix README and some references to MultiMC. 2021-12-13 23:31:29 +05:30			`## Copyright`
			`Copyright 2013-2021 MultiMC contributors`
			`Copyright 2021 PolyMC contributors`