Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/projectinfinity/pocketpanel
[WIP] A wrapper for PocketMine. This is incredibly early in development, do not attempt to use. EXTREMELY MESSY!
https://github.com/projectinfinity/pocketpanel
Last synced: about 1 month ago
JSON representation
[WIP] A wrapper for PocketMine. This is incredibly early in development, do not attempt to use. EXTREMELY MESSY!
- Host: GitHub
- URL: https://github.com/projectinfinity/pocketpanel
- Owner: ProjectInfinity
- License: bsd-3-clause
- Created: 2017-10-04T16:59:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-16T19:09:43.000Z (about 7 years ago)
- Last Synced: 2024-12-01T21:36:29.200Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://pocketpanel.io
- Size: 121 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PocketPanel [WIP]
[](https://gitter.im/ProjectInfinity/PocketPanel?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Links will come here shortly. In the meantime enjoy some placeholder text because neither the forums nor the panel GUI is up yet.
## What is PocketPanel?
PocketPanel is both a wrapper and a web-based graphical user interface to control your Minecraft Pocket Edition server.
The wrapper is completely free to use and open source, the Web Interface has a free hosted version with premium options available for power users. Running standalone provides you with (currently) all features available in PocketPanel in form of console commands, some features are expected to only be available where there is a interface to work with.
## Installation
### Ubuntu / Debian
#### Install dependencies
Ensure NodeJS is installed and is at least version 8.0 or above.
Open your terminal and type `node -v`, you should see something similar to the following output:
```bash
alex@linbox:~$ node -v
v8.9.1
```
If the terminal shows a version lower than 8.0 or if it says `node: command not found` then you have to install NodeJS version 8.
```bash
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs build-essential git
```
Once installed, open up terminal again and type `node -v` to ensure NodeJS is recognized.
#### Get Pocketpanel
Next download the source code for the wrapper, you can either do this by downloading the repository as a ZIP archive or by cloning it (recommended). I will be providing the instructions using git.
Navigate (using your terminal) to where you want PocketPanel to be stored and type
```bash
git clone https://github.com/ProjectInfinity/PocketPanel.git
```
#### Running PocketPanel
Cd into your new PocketPanel directory and type
```bash
npm install
```
This may take a minute or two, please do not interrupt the proccess.
**Important: Right now the new server setup is incomplete, so you need to copy a working server to a folder called `server` inside the main PocketPanel folder!**
Once completed you may type
```bash
npm start
```
to run PocketPanel.
PocketPanel runs in the foreground so make sure you do not close the terminal as that will also close your server. This may change in the future. It is recommended to use something like `tmux` or `screen` with PocketPanel at this time.
- - -
### CentOS / RHEL
### Install dependencies
Ensure NodeJS is installed and is at least version 8.0 or above.
Open your terminal and type `node -v`, you should see something similar to the following output:
```bash
alex@linbox:~$ node -v
v8.9.1
```
If the terminal shows a version lower than 8.0 or if it says `node: command not found` then you have to install NodeJS version 8.
```bash
curl --silent --location https://rpm.nodesource.com/setup_8.x | sudo bash -
sudo yum -y install nodejs gcc-c++ make git
```
CentOS and RHEL do not differ much from Ubuntu / Debian, install dependencies and then continue from the [Ubuntu/Debian Running PocketPanel](https://github.com/ProjectInfinity/PocketPanel#running-pocketpanel) step.
- - -
### macOS
-- Coming soon --
- - -
### Windows
#### Install dependencies
Ensure NodeJS is installed and is at least version 8.0 or above.
To check your installed NodeJS version, press Windows + R and type `cmd` in the text field.
Once CMD has opened, type `node -v` in your CMD window. If installed it should show you something similar to the following output:
```cmd
C:\Users\Alex>node -v
v8.1.4
```
If the window shows a version lower than 8.0 or if it says `'node' is not recognized as an internal or external command, operable program or batch file.` then you have to install NodeJS version 8.
Go to the following page and download NodeJS, you can choose either the `LTS` or `Current` version. Both will work.
Once installed, open up CMD like mentioned earlier and type `node -v` to ensure NodeJS is recognized.
#### Get PocketPanel
Next download the source code for the wrapper, you can either do this by downloading the repository as a ZIP archive or by cloning it (recommended).
If you have git installed (download it here ) and it is available in your path, open up CMD by pressing Windows + R and typing in cmd. Once opened navigate to where you want PocketPanel to be located, then proceed by typing
```bash
git clone https://github.com/ProjectInfinity/PocketPanel.git
```
Alternatively you can download the repository as a ZIP archive by clicking the following link:
Once downloaded, extract it where you want PocketPanel to be located and proceed to the next step.
#### Running PocketPanel
In your CMD window, ensure you are in the directory of PocketPanel and type
```bash
npm install
```
to install the PocketPanel dependencies. This may take a minute or two, so don't cancel it.
**Important: Right now the new server setup is incomplete, so you need to copy a working server to a folder called `server` inside the main PocketPanel folder!**
Once completed you may type
```bash
npm start
```
to run PocketPanel.
PocketPanel runs in the foreground so make sure you do not close the window as that will also close your server. This may change in the future.
- - -
### BSD
Follow the Linux instructions for guidance. If you're using BSD I hope you're familiar enough with the operating system to run a NodeJS program.
- - -
## Caveats
Since PocketPanel is incredibly early in development it is **not** ready to be seriously used by anyone yet. If you really wish to try it out however, it is recommended to take a backup of your server and copy all the files into a folder called `server` inside the main PocketPanel folder.
Like mentioned above, **you are required** to copy all your currently working server files into a folder called `server` in the main PocketPanel folder.
Another thing you need to make sure is that the PocketMine PHAR file is located inside the `server` folder and is called `PocketMine-MP.phar`.