planet/README.md

<br/>
<p align="center">
  <a href="https://github.com/mcpiscript/Planet">
    <img src="https://github.com/mcpiscript/planet/raw/master/planet/assets/logo512.png" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">Planet Launcher</h3>

  <p align="center">
    A better, maintained launcher for the Minecraft: Pi Edition Reborn mod.
    <br/>
    <br/>
    <a href="https://github.com/mcpiscript/Planet/issues">Report Bug</a>
    |
    <a href="https://github.com/mcpiscript/Planet/issues">Request Feature</a>
  </p>
</p>


![Downloads](https://img.shields.io/github/downloads/mcpiscript/Planet/total) ![Contributors](https://img.shields.io/github/contributors/mcpiscript/Planet?color=dark-green) ![Issues](https://img.shields.io/github/issues/mcpiscript/Planet) ![License](https://img.shields.io/github/license/mcpiscript/Planet) [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fmcpiscript%2FPlanet&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com) ![Discord](https://img.shields.io/discord/936428193521487953?color=blue&label=Discord%20server&logo=Discord&logoColor=blue) ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/mcpiscript/planet?label=Commits) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/mcpiscript/planet/latest/master) ![GitHub last commit](https://img.shields.io/github/last-commit/mcpiscript/planet) ![GitHub Release Date](https://img.shields.io/github/release-date/mcpiscript/planet?label=Latest%20release%20date) ![GitHub repo size](https://img.shields.io/github/repo-size/mcpiscript/planet)


<!--## Table Of Contents

* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
  * [Prerequisites](#prerequisites)
  * [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Authors](#authors)
* [Acknowledgements](#acknowledgements)
-->

![Screenshot](https://github.com/mcpiscript/planet/raw/master/screenshot.png)

Planet is a **maintained, feature-rich and a flexible** launcher. It is supported everywhere: Just install PyQt5, Python, and MCPi, and you're done! Planet was created because none of the other launchers were universal, stable, maintained and feature-rich.
## Installation
#### Prerequisites
* [Minecraft Pi: Reborn](https://jenkins.thebrokenrail.com) AppImage or DEB install
* PyQt5
* Python 3
* `pypresence`
* `pyqtdarkmode`
* Pillow

If you're installing a DEB, all of them with the exception of Minecraft: Pi Edition: Reborn will be automatically installed. Please install an AppImage for the latest build. If you want a DEB, please consider checking out [MCPI++](https://github.com/mobilegmyt/mcpi-reborn-extended).
#### Installation
1. Download the DEB from the releases section.
2. Install the DEB using `apt`
3. Follow the on-screen instructions

### gMCPIL vs jMCPIL vs pipan vs Planet
| Feature | Planet | [gMCPIL](https://github.com/mcpi-revival/gmcpil) | [jMCPIL](https://github.com/mcpi-revival/jmcpil) | [pipan](https://github.com/randomsoup/pipan) | Built-in launcher |
|---------|--------|--------|--------|-------|------|
| Profile & feature saving | Yes | Bullseye only | Yes | No | No |
| AppImage support | Yes | No | No | No | Yes |
| Legacy DEB support | Yes | Yes | Yes | Yes | Yes |
| Official MCPi-Revival | No | Yes | Yes | No | Yes |
| Tab icons | Yes | No | No | No | No |
| Maintained | Yes | No | No | No | Yes |
| Supported on Debian Buster | Yes | No | Yes | Yes | Yes |
| Discord RPC | Yes | No | No | No | No |
| External server support | Yes | Yes | Yes | No | No |
| Flatpak support | Not tested | No | No | No | Yes |
| Pre-made profiles | Yes | Yes | Yes | Yes | No |
| Easy GUI navigation | Yes | Yes | Yes | No | Yes |
| Skin support | Yes | No | No | No | No |
###### Conclusion
- Use Planet if you want a maintained and a feature-rich launcher.
- Use gMCPIL if you are on Debian Bullseye, using a DEB install OR want a basic experience
- Use jMCPIL if you're using a DEB install on a distro other than Debian Bullseye
- Use the built-in launcher if you like to fill in things constantly
- Don't use pipan, it's a dirty prototype, not a working launcher
## Credits
- [Leha-code](https://github.com/leha-code) - Creator and maintainer
- [Red-exe-engineer](https://github.com/red-exe-engineer) - Active contributor
- [Bigjango13](https://github.com/bigjango13) - Multiple fixes

### Additional Credits
Heart, Planet, Pi, Steve and Portal icons by LEHAtupointow