planet/README.md

76 lines
3.1 KiB
Markdown
Raw Normal View History

2022-03-18 14:36:26 +00:00
<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 launcher for the Minecraft: Pi Edition Reborn mod.
<br/>
<br/>
<a href="https://github.com/mcpiscript/Planet/issues">Report Bug</a>
2022-03-19 22:31:09 +00:00
|
2022-03-18 14:36:26 +00:00
<a href="https://github.com/mcpiscript/Planet/issues">Request Feature</a>
</p>
</p>
2022-03-20 18:27:43 +00:00
<center>
2022-03-19 22:31:09 +00:00
![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)
2022-03-20 18:27:43 +00:00
</center>
2022-03-18 14:36:26 +00:00
<!--## 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)
-->
2022-03-05 00:50:21 +00:00
![Screenshot](https://github.com/mcpiscript/planet/raw/master/screenshot.png)
2022-03-19 22:31:09 +00:00
<!--
**Is there a a launcher for MCPi that works everywhere and has all the essenitial features?**:
Yes there is. Introducing Planet. Planet was made because the other launchers didn't work properly or were unmaintained.
And, no launcher supports AppImage, thus Planet is required to run new versions of MCPi-Reborn.-->
## Installation
#### Prerequisites
* [Minecraft Pi: Reborn](https://jenkins.thebrokenrail.com) AppImage or DEB install
#### Installation
1. Download the DEB from the releases section.
2. Install the DEB using `apt`
3. Follow the on-screen instructions
2022-03-10 00:32:59 +00:00
2022-03-19 22:31:09 +00:00
### 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) |
|---------|--------|--------|--------|-------|
2022-03-20 17:55:06 +00:00
| Profile & feature saving | Yes | Bullseye only | Yes | No |
2022-03-19 22:31:09 +00:00
| AppImage support | Yes | No | No | No |
| Legacy DEB support | Yes | Yes | Yes | Yes |
| Official MCPi-Revival | No | Yes | Yes | No |
| Tab icons | Yes | No | No | No |
2022-03-20 17:55:06 +00:00
| Maintained | Yes | Yes | No | No |
2022-03-19 22:31:09 +00:00
| Supported on Debian Buster | Yes | No | Yes | Yes |
| Discord RPC | Yes | No | No | No |
| External server support | Yes | Yes | Yes | No |
| Flatpak support | Yes | No | No | No |
2022-03-20 18:27:43 +00:00
| Pre-made profiles | Yes | Yes | Yes | Yes |
2022-03-19 22:31:09 +00:00
| Easy GUI navigation | Yes | Yes | Yes | No |
2022-03-20 17:55:06 +00:00
| Skin support | Yes | No | No | No |
2022-03-18 17:29:01 +00:00
## Credits
- @leha-code - Creator and maintainer
- @red-exe-engineer - Active contributor
2022-03-19 22:31:09 +00:00
- @bigjango13 - Multiple fixes
2022-03-18 17:29:01 +00:00
2022-03-10 00:32:59 +00:00
### Additional Credits
2022-03-18 17:29:01 +00:00
Heart, Planet, Pi, Steve and Portal icons by LEHAtupointow