Sneederix/sneedmc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,887 Commits 1 Branch 19 Tags 35 MiB
C++ 90.5%
C 5.8%
CMake 2.6%
Java 0.9%
Shell 0.2%
4435665d87
Go to file
Lenny McLennington 4435665d87
Add development section back to README.md
2021-12-26 21:58:53 +00:00
.github/ISSUE_TEMPLATE Matrix room/space, a bit more rebranding 2021-12-24 14:28:54 -05:00
buildconfig Move MSA Client ID to the same place as the others 2021-12-20 02:57:13 +00:00
cmake NOISSUE continue debranding... 2021-10-21 00:47:53 +02:00
doc pre-emptive work on PolyMC "rebranding" 2021-12-23 18:18:37 -05:00
launcher update README, delete RPM/Ubuntu packaging dirs 2021-12-26 16:01:29 -05:00
libraries update submodule 2021-12-21 00:03:43 +00:00
program_info Move MSA Client ID to the same place as the others 2021-12-20 02:57:13 +00:00
.gitattributes NOISSUE reorganize unit tests to be placed next to the code they test. Nuke more dead tests. 2016-05-01 00:02:15 +02:00
.gitignore Move MSA Client ID to the same place as the others 2021-12-20 02:57:13 +00:00
.gitmodules update submodule 2021-12-21 00:03:43 +00:00
BUILD.md pre-emptive work on PolyMC "rebranding" 2021-12-23 18:18:37 -05:00
changelog.md NOISSUE party hat for a party cat 2021-12-05 23:26:04 +01:00
CMakeLists.txt Move MSA Client ID to the same place as the others 2021-12-20 02:57:13 +00:00
COPYING.md gpl 2021-12-18 14:33:17 +00:00
README.md Add development section back to README.md 2021-12-26 21:58:53 +00:00

README.md

PolyMC logo

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?" 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
  • Change up packaging, remove the install script junk
  • AppImage, Flatpak, .deb, ebuild, and AUR packages
  • Meson
  • Long-term solution for the MSA client ID issue
  • 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.
  • Last build status: https://jenkins.swurl.xyz/job/PolyMC/lastBuild/
  • Linux (AMD64) System - this is a generic system package intended to be used as a base for making distro-specific packages.
  • Windows (32-bit) - this is a portable package, you can extract it anywhere and run it. This package needs testing.
  • MacOS currently does not have any packages. We are still working on setting up MacOS packaging.

Development

If you want to contribute to PolyMC you might find it useful to join #development:polymc.org on Matrix or join our Discord server, which is bridged with the PolyMC Matrix rooms. Thank you!

Building

If you want to build PolyMC yourself, check 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.

Help & Support

Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server.

PolyMC Discord

For people who don't want to use Discord, we have a Matrix Space which is bridged to the discord server. Be sure to enable spaces first (Settings -> Labs -> Spaces), and then you may join the space:

PolyMC Space

Matrix's support for spaces is still in development, so if you have issues accessing rooms via the space, then you can join the rooms directly:

Support Discussion Development News