mirror of
https://scm.osdn.net/gitroot/planet/planet-launcher.git
synced 2024-08-15 03:28:13 +00:00
Re-make readme
This commit is contained in:
parent
eeb234011c
commit
9f2c239d06
1 changed files with 61 additions and 18 deletions
79
README.md
79
README.md
|
@ -7,44 +7,55 @@
|
|||
<h3 align="center">Planet Launcher</h3>
|
||||
|
||||
<p align="center">
|
||||
A better, maintained launcher for the Minecraft: Pi Edition Reborn mod.
|
||||
An interactive launcher for MCPi-Reborn
|
||||
<br/>
|
||||
<br/>
|
||||
<a href="https://github.com/mcpiscript/Planet"><strong>Explore the docs »</strong></a>
|
||||
<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) [![Crowdin](https://badges.crowdin.net/planet-launcher/localized.svg)](https://crowdin.com/project/planet-launcher)
|
||||
|
||||
|
||||
<!--## Table Of Contents
|
||||
## Table Of Contents
|
||||
|
||||
* [About the Project](#about-the-project)
|
||||
* [Built With](#built-with)
|
||||
* [Getting Started](#getting-started)
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [Installation](#installation)
|
||||
* [Usage](#usage)
|
||||
* [Getting Started](#installation)
|
||||
* [Roadmap](#roadmap)
|
||||
* [Contributing](#contributing)
|
||||
* [License](#license)
|
||||
* [Authors](#authors)
|
||||
* [Acknowledgements](#acknowledgements)
|
||||
-->
|
||||
|
||||
![Screenshot](https://github.com/mcpiscript/planet/raw/master/screenshot.png)
|
||||
## About The Project
|
||||
|
||||
![Screen Shot](https://github.com/mcpiscript/Planet/raw/master/screenshot.png)
|
||||
|
||||
The Minecraft Pi: Reborn mod is a great addition to the game. However, as fun as it can be, there is a big problem. The built-in launcher is too annoying. You have to type in every single field to just remember that you forgot to turn on a teeny little flag. **Planet fixes that.**
|
||||
Instead of making you type in every single field, Planet lets you write it one time, auto-save, and forget for the rest of your life. With Planet you can even edit the world names and it supports the newly-introduced Reborn AppImages. It is also maintained unlike the other launchers.
|
||||
|
||||
|
||||
## Built With
|
||||
|
||||
* The GUI is made using the PyQt5 Qt binding for Python, and additional widgets from qtwidgets.
|
||||
* Big thanks to `pypresence` developers, for making such a good interface to Discord RPC.
|
||||
* Thanks to `pyqtdarktheme` and `darkdetect` for awesome Qt theming tools.
|
||||
* Pillow was used for skin manipulation
|
||||
* PyNBT is used for the built-in MCPIedit
|
||||
* `click` is an awesome interface, unfortunately, not to handle autoclickers, but for CLI interfaces used in the texture pack tool.
|
||||
|
||||
|
||||
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`
|
||||
* `qtdarktheme`
|
||||
* Pillow
|
||||
* `qtwidgets`
|
||||
* `darkdetect`
|
||||
|
@ -67,6 +78,9 @@ Use [our PPA](https://github.com/mcpiscript/ppa)
|
|||
2. Install the DEB using `apt`
|
||||
3. Follow the on-screen instructions
|
||||
|
||||
|
||||
|
||||
## Alternatives
|
||||
### 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 |
|
||||
|---------|--------|--------|--------|-------|------|
|
||||
|
@ -91,28 +105,57 @@ Use [our PPA](https://github.com/mcpiscript/ppa)
|
|||
- 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
|
||||
|
||||
|
||||
## Roadmap
|
||||
|
||||
- [x] AppImage support
|
||||
- [x] Skin support
|
||||
- [x] NBT editor
|
||||
- [x] Localization system [![Crowdin](https://badges.crowdin.net/planet-launcher/localized.svg)](https://crowdin.com/project/planet-launcher)
|
||||
- [ ] Texture packs (In progress)
|
||||
- [ ] Mods
|
||||
- [ ] Chat logging
|
||||
- [ ] MarketPi
|
||||
- [ ] World generation from seed
|
||||
|
||||
## Contributing
|
||||
|
||||
### Creating A Pull Request
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
### Adding a translation
|
||||
[![Crowdin](https://badges.crowdin.net/planet-launcher/localized.svg)](https://crowdin.com/project/planet-launcher)
|
||||
|
||||
1. Register an account on [Crowdin](https://crowdin.com)
|
||||
2. Go to our [project page](https://crowdin.com/project/planet-launcher)
|
||||
3. Start translating. If the desired langauge is not available, start a new thread.
|
||||
4. Patiently wait until your translation is reviewed and added.
|
||||
|
||||
Please don't add fake translations, invalid or rude translations.
|
||||
|
||||
## License
|
||||
|
||||
Planet is licensed under the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||
|
||||
|
||||
![Logo](https://www.gnu.org/graphics/agplv3-with-text-162x68.png)
|
||||
|
||||
|
||||
## Credits
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
- [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
|
||||
|
||||
### Translations
|
||||
- Spanish translation by [BasedSkeleton](https://github.com/basedskeleton)
|
||||
- Russian translation by [Leha-code](https://github.com/leha-code)
|
||||
|
||||
### Additional Credits
|
||||
Heart, Planet, Pi, Steve and Portal icons by LEHAtupointow.
|
||||
Wrench by [Santoniche on OpenGameArt.org](https://opengameart.org/content/wrench-0).
|
||||
- Heart, Planet, Pi, Steve and Portal icons by LEHAtupointow.
|
||||
- Wrench by [Santoniche on OpenGameArt.org](https://opengameart.org/content/wrench-0).
|
||||
|
|
Loading…
Reference in a new issue