MultiMC5/README.md
Alfio 8d100ba97c
Update README.md
fixed a couple of typos and reformatted some stuff to be a little more legible.
2022-09-11 16:59:00 +02:00

3.0 KiB

MultiMC logo

MultiMC

MultiMC is a custom launcher for Minecraft that focuses on predictability, long term stability and simplicity.

Development

If you want to contribute, talk to us on Discord 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 disruption or endangering the future viability of the project is OK.

Building

If you want to build the launcher 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

Translations can be done on crowdin. Please avoid making direct pull requests to the translations repository.

License

Copyright © 2013-2022 MultiMC Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this program except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Forking/Redistributing/Custom builds policy

We keep Launcher open source because we think it's important to be able to see the source code for a project like this, and we do so using the Apache license.

The license gives you access to the source MultiMC is built from, but not:

  • The name, logo and other branding.
  • The API tokens required to talk to services that the launcher depends on.

Because of the nature of the agreements required to interact with the Microsoft identity platform, it's impossible for us to continue allowing everyone to build the code as 'MultiMC'. The source code has been debranded and now builds as DevLauncher by default.

You must provide your own branding if you want to distribute your own builds.

You will also have to register your own app on Azure to be able to handle Microsoft account logins.

If you decide to fork the project, a mention of its origins in the About dialog and the license is acceptable. However, it should be abundantly clear that the project is a fork without implying that you have our blessing.