From 9ecc1ae101ed0454df33cb0e0e7f8e3a4600f490 Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Sat, 12 Aug 2017 21:03:10 -0400 Subject: [PATCH 1/7] Update README.md --- README.md | 58 ++++--------------------------------------------------- 1 file changed, 4 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 97fc0d0a3..ed7a4cf00 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,10 @@ # Steadfast2 ## Getting Started -Steadfast is a project for backporting new Minecraft: Pocket Edition changes to older Pocketmine versions for better stability and performance, while retaining as many features from the new versions as possible. It's currently in production on Lifeboat Survival Games' main servers. + Check out our [wiki](https://github.com/Hydreon/Steadfast2/wiki) for guides on installation for [windows](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Windows), [MacOS and Linux.](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Linux-MacOS) You will also find information on how to [stop and start the server](https://github.com/Hydreon/Steadfast2/wiki/Starting-and-Stopping-the-server), along with a detailed guide on [how to use plugins](https://github.com/Hydreon/Steadfast2/wiki/How-to-use-plugins). Remember to check out our helpful [notes](https://github.com/Hydreon/Steadfast2/wiki/Notes)-- Be sure to read these before creating a Steadfast2 phar! -Things you might want to change before building: - - Saving the server.log is disabled because it takes a lot of time to write to disk - - The default MOTD for responding to MCPE server list queries is set in RaklibInterface (is currently set to Lifeboat Network) +### Known bugs: +Visit the [issues page](https://github.com/Hydreon/Steadfast2/issues) for a list of known bugs in Steadfast2. -#### Known bugs: - -Things you'll want to change on your plugins: +### Things you'll want to change on your plugins: - Players don't fall out of the world naturally, you'll want to handle PlayerMoveEvent as needed to kill them - - -### Installing - -#### Linux/MacOS -1) `git clone git@github.com:Hydreon/Steadfast2.git` or `https://github.com/Hydreon/Steadfast2.git` in directory of your choosing. Or download and extract zip into directory of choosing. - -2) Navigate to `Steadfast2` directory via command line - -3) Run command `./installer` - - If successful this will create a `bin` directory with a special Php7 build in it and a `start.sh` shell script - -4) Running `./start` for the first time will take through a set up wizard where and create the 2 main config files for your server `pocketmine.yml` and `server.properties` - -#### Windows -We suggest a Linux VM in the meantime. We also suggest using Vagrant and picking a Ubuntu box -> [from here](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=&q=ubuntu) - -1) To install SteadyFast2 on windows OS, first you need to download the PocketMine PHP7 installer -> [from here](https://github.com/NotPocketMine/Windows-PocketMine-MP/raw/master/PocketMine-MP-x64.exe) - -2) Next, you need to run the PocketMine installer then follow the instructions provide in the installer. - -3) Then you need to navigate to your user's documents file, and delete PocketMine-MP.phar. - -4) Finally, you need to move SteadyFast2.phar into the directory above and run start.cmd. - - Notes: - - - If using Vagrant have a config of `config.vm.network "public_network"` in the `Vagrantfile` should make your server discoverable from LAN. - - -### Starting/Stopping Server - - Run command `./start` in from server root directory - - To stop the server `stop` in running servers terminal. (or CTRL + C should work). - -### Plugins - - Plugins go into the `plugins` in your servers root directory. Plugins will using come in the form of a `phar` but if you want to create plugins or run plugins from source then you need the DevTools plugin (DevToolvX.X.X.phar). You can get a copy from [Here](http://forums.pocketmine.net/plugins/devtools.515/) or other places as well. - - To create a plugin phar from source code you will also need the DevTools plugin. - -### Building - - -To build a server phar, run the server with [DevTools](http://forums.pocketmine.net/plugins/devtools.515/) plugin installed then run `makeserver` in the server terminal. It'll drop a phar file in it's plugin directory. From ed4e1ab7f837e4c5df1874c1dc01f546856fb093 Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Fri, 18 Aug 2017 10:46:13 -0400 Subject: [PATCH 2/7] Update README.md --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/README.md b/README.md index ed7a4cf00..db7adcbf4 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,81 @@ ## Getting Started Check out our [wiki](https://github.com/Hydreon/Steadfast2/wiki) for guides on installation for [windows](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Windows), [MacOS and Linux.](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Linux-MacOS) You will also find information on how to [stop and start the server](https://github.com/Hydreon/Steadfast2/wiki/Starting-and-Stopping-the-server), along with a detailed guide on [how to use plugins](https://github.com/Hydreon/Steadfast2/wiki/How-to-use-plugins). Remember to check out our helpful [notes](https://github.com/Hydreon/Steadfast2/wiki/Notes)-- Be sure to read these before creating a Steadfast2 phar! +### About Steadfast +Steadfast is a project for backporting new Minecraft: Pocket Edition changes to older Pocketmine versions for better stability and performance, while retaining as many features from the new versions as possible. It's currently in production on Lifeboat Survival Games' main servers. + +### How to use plugins +Plugins normally come in the form of a phar file: a php archive. Steadfast2 is coded in the PHP language, and so are the plugins. To run a plugin in the form of a phar file, place the plugin into the plugins directory of the server. + +If the plugin is not in the form of a phar, something which happens often when downloading the plugin from its github repository, follow these steps: + +Download the plugin +Place it in the plugins directory +Unzip it, so the file structure is as shown here: +Steadfast2 Installation Directory +├── plugins +ᅠᅠᅠ└── src +ᅠᅠᅠᅠᅠᅠ└── PluginName +ᅠᅠᅠᅠᅠᅠᅠᅠᅠ└── plugin.yml +4. Once the file structure is as shown above, you are good to go! Start the server and have fun! + +### Installation on Linux and MacOS +`git clone git@github.com:Hydreon/Steadfast2.git` or `https://github.com/Hydreon/Steadfast2.git` in directory of your choosing. Or download and extract zip into directory of choosing. + +Navigate to `Steadfast2` directory via command line + +Run command `./installer` + +If successful this will create a `bin` directory with a special Php7 build in it and a `start.sh` shell script + +Running `./start` for the first time will take through a set up wizard where and create the 2 main config files for your server `pocketmine.yml` and `server.properties` + +#### Notes: + +If using Vagrant have a config of `config.vm.network "public_network"` in the `Vagrantfile` should make your server discoverable from LAN. + + +### Installation on Windows + +1. Install [Visual C++ Studio 2015- x64 or x86](https://www.microsoft.com/en-us/download/confirmation.aspx?id=48145) +2. Download Steadfast´s windows launcher from [HERE](https://github.com/Inactive-to-Reactive/Windows-PHP7-Launcher/archive/master.zip) (Originally from ImagicalMine, it works still) +3. Download Steadfast2's source from [HERE](https://github.com/Hydreon/Steadfast2/archive/master.zip) +4. Extract the Steadfast zip in the same directory as the windows launcher +5. Run the "start.cmd" file +6. After setup, type "makeserver" to create a steadfast phar [NOTE: Before doing this, click me and read this](https://github.com/Hydreon/Steadfast2/wiki/Notes) +7. Type "stop" to safely stop the server, then close the window +8. Navigate to the plugins directory, then to the DevTools directory and copy the phar file that is there into the root directory (where Steadfast2 was installed). Name the phar "Software.phar" +9. Run the "start.cmd" file again +10. Have fun with Steadfast2! + +#### If you are seeing the error below, it means that you incorrectly installed vcredist. +'/usr/bin/php/php.exe: error while loading shared libraries: VCRUNTIME140.dll: cannot open shared object file: No such file or directory bin\php\php.exe: Exit 127' + +(means you have installed the x86 version, therefore you need the x64 version of Visual Studio C++ Redist. or if you have installed the x86 version, you need the x64 Visual Studio C++ Redist. version) + +#### How to fix: +Revisit the link in step 1. If you originally downloaded x86, now download x64. If you originally downloaded x64, now download x86. +Install, and try again, it should now work. Contact @TheRoyalBlock if this still does not work. + +### Things you'll want to do before building a phar: +Saving the server.log is disabled by default, but many people would like to change this. + +The default MOTD for responding to MCPE server list queries is set in RaklibInterface (is currently set to Lifeboat Network). To access RaklibInterface, navigate to the Steadfast directory, then go to src-->pocketmine-->network-->RaklibInterface.php and change the motd + +### Starting the server on windows +Navigate to the directory in which Steadfast is installed +Run the `start.cmd` file to start + +### Stopping the server on windows +Open the server window and type `stop` + +### Starting the server on Linux/MacOS +Run command ./start in from server root directory + +### Stopping the server on Linux/MacOS +To stop the server stop in running servers terminal. (or CTRL + C should work). + + ### Known bugs: Visit the [issues page](https://github.com/Hydreon/Steadfast2/issues) for a list of known bugs in Steadfast2. From c3d49cc47ddd533edb0819ab2f0bfc1d23e0d0f4 Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Fri, 18 Aug 2017 10:46:38 -0400 Subject: [PATCH 3/7] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index db7adcbf4..0382ff0fe 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ If the plugin is not in the form of a phar, something which happens often when d Download the plugin Place it in the plugins directory Unzip it, so the file structure is as shown here: -Steadfast2 Installation Directory -├── plugins -ᅠᅠᅠ└── src -ᅠᅠᅠᅠᅠᅠ└── PluginName -ᅠᅠᅠᅠᅠᅠᅠᅠᅠ└── plugin.yml +Steadfast2 Installation Directory
+├── plugins
+ᅠᅠᅠ└── src
+ᅠᅠᅠᅠᅠᅠ└── PluginName
+ᅠᅠᅠᅠᅠᅠᅠᅠᅠ└── plugin.yml
4. Once the file structure is as shown above, you are good to go! Start the server and have fun! ### Installation on Linux and MacOS From 5fb5ad86e473c892531ebcb3507583b3cdb3a87a Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Fri, 18 Aug 2017 10:47:50 -0400 Subject: [PATCH 4/7] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0382ff0fe..22e3f4237 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ Plugins normally come in the form of a phar file: a php archive. Steadfast2 is c If the plugin is not in the form of a phar, something which happens often when downloading the plugin from its github repository, follow these steps: -Download the plugin -Place it in the plugins directory -Unzip it, so the file structure is as shown here: +Download the plugin
+Place it in the plugins directory
+Unzip it, so the file structure is as shown here:
Steadfast2 Installation Directory
├── plugins
ᅠᅠᅠ└── src
@@ -22,15 +22,15 @@ Steadfast2 Installation Directory
4. Once the file structure is as shown above, you are good to go! Start the server and have fun! ### Installation on Linux and MacOS -`git clone git@github.com:Hydreon/Steadfast2.git` or `https://github.com/Hydreon/Steadfast2.git` in directory of your choosing. Or download and extract zip into directory of choosing. - -Navigate to `Steadfast2` directory via command line - -Run command `./installer` - -If successful this will create a `bin` directory with a special Php7 build in it and a `start.sh` shell script - -Running `./start` for the first time will take through a set up wizard where and create the 2 main config files for your server `pocketmine.yml` and `server.properties` +`git clone git@github.com:Hydreon/Steadfast2.git` or `https://github.com/Hydreon/Steadfast2.git` in directory of your choosing. Or download and extract zip into directory of choosing.
+
+Navigate to `Steadfast2` directory via command line
+
+Run command `./installer`
+
+If successful this will create a `bin` directory with a special Php7 build in it and a `start.sh` shell script
+
+Running `./start` for the first time will take through a set up wizard where and create the 2 main config files for your server `pocketmine.yml` and `server.properties`
#### Notes: From b23987cabd00cfc78e34e19e1817cd3551998f38 Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Fri, 18 Aug 2017 10:49:26 -0400 Subject: [PATCH 5/7] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22e3f4237..e7b41d02b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -# Steadfast2 + # LBSG logo +# Steadfast2: Minecraft Server Software ## Getting Started Check out our [wiki](https://github.com/Hydreon/Steadfast2/wiki) for guides on installation for [windows](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Windows), [MacOS and Linux.](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Linux-MacOS) You will also find information on how to [stop and start the server](https://github.com/Hydreon/Steadfast2/wiki/Starting-and-Stopping-the-server), along with a detailed guide on [how to use plugins](https://github.com/Hydreon/Steadfast2/wiki/How-to-use-plugins). Remember to check out our helpful [notes](https://github.com/Hydreon/Steadfast2/wiki/Notes)-- Be sure to read these before creating a Steadfast2 phar! ### About Steadfast -Steadfast is a project for backporting new Minecraft: Pocket Edition changes to older Pocketmine versions for better stability and performance, while retaining as many features from the new versions as possible. It's currently in production on Lifeboat Survival Games' main servers. +Steadfast is a project for backporting new Minecraft: Pocket Edition changes to older Pocketmine versions for better stability and performance, while retaining as many features from the new versions as possible. It's currently in production on Lifeboat Survival Games' main servers. Steadfast supports Pocket edition **and** Bedrock Edition (1.2+). ### How to use plugins Plugins normally come in the form of a phar file: a php archive. Steadfast2 is coded in the PHP language, and so are the plugins. To run a plugin in the form of a phar file, place the plugin into the plugins directory of the server. From 3112a1928f48b605b516cf1ee650f4f199f3d705 Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Fri, 18 Aug 2017 10:51:13 -0400 Subject: [PATCH 6/7] I think I'm Done! I also added extra spaces between sections --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7b41d02b..e854cdd4c 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,13 @@ ## Getting Started Check out our [wiki](https://github.com/Hydreon/Steadfast2/wiki) for guides on installation for [windows](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Windows), [MacOS and Linux.](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Linux-MacOS) You will also find information on how to [stop and start the server](https://github.com/Hydreon/Steadfast2/wiki/Starting-and-Stopping-the-server), along with a detailed guide on [how to use plugins](https://github.com/Hydreon/Steadfast2/wiki/How-to-use-plugins). Remember to check out our helpful [notes](https://github.com/Hydreon/Steadfast2/wiki/Notes)-- Be sure to read these before creating a Steadfast2 phar! + + ### About Steadfast Steadfast is a project for backporting new Minecraft: Pocket Edition changes to older Pocketmine versions for better stability and performance, while retaining as many features from the new versions as possible. It's currently in production on Lifeboat Survival Games' main servers. Steadfast supports Pocket edition **and** Bedrock Edition (1.2+). + + ### How to use plugins Plugins normally come in the form of a phar file: a php archive. Steadfast2 is coded in the PHP language, and so are the plugins. To run a plugin in the form of a phar file, place the plugin into the plugins directory of the server. @@ -22,6 +26,8 @@ Steadfast2 Installation Directory
ᅠᅠᅠᅠᅠᅠᅠᅠᅠ└── plugin.yml
4. Once the file structure is as shown above, you are good to go! Start the server and have fun! + + ### Installation on Linux and MacOS `git clone git@github.com:Hydreon/Steadfast2.git` or `https://github.com/Hydreon/Steadfast2.git` in directory of your choosing. Or download and extract zip into directory of choosing.

@@ -33,11 +39,12 @@ If successful this will create a `bin` directory with a special Php7 build in it
Running `./start` for the first time will take through a set up wizard where and create the 2 main config files for your server `pocketmine.yml` and `server.properties`
-#### Notes: +#### Linux VM Notes: If using Vagrant have a config of `config.vm.network "public_network"` in the `Vagrantfile` should make your server discoverable from LAN. + ### Installation on Windows 1. Install [Visual C++ Studio 2015- x64 or x86](https://www.microsoft.com/en-us/download/confirmation.aspx?id=48145) @@ -60,11 +67,15 @@ If using Vagrant have a config of `config.vm.network "public_network"` in the `V Revisit the link in step 1. If you originally downloaded x86, now download x64. If you originally downloaded x64, now download x86. Install, and try again, it should now work. Contact @TheRoyalBlock if this still does not work. + + ### Things you'll want to do before building a phar: Saving the server.log is disabled by default, but many people would like to change this. The default MOTD for responding to MCPE server list queries is set in RaklibInterface (is currently set to Lifeboat Network). To access RaklibInterface, navigate to the Steadfast directory, then go to src-->pocketmine-->network-->RaklibInterface.php and change the motd + + ### Starting the server on windows Navigate to the directory in which Steadfast is installed Run the `start.cmd` file to start @@ -72,6 +83,8 @@ Run the `start.cmd` file to start ### Stopping the server on windows Open the server window and type `stop` + + ### Starting the server on Linux/MacOS Run command ./start in from server root directory @@ -79,8 +92,11 @@ Run command ./start in from server root directory To stop the server stop in running servers terminal. (or CTRL + C should work). + ### Known bugs: Visit the [issues page](https://github.com/Hydreon/Steadfast2/issues) for a list of known bugs in Steadfast2. + + ### Things you'll want to change on your plugins: - Players don't fall out of the world naturally, you'll want to handle PlayerMoveEvent as needed to kill them From 1f1218ec482e88ba51bf6af99d0dc1c31905413d Mon Sep 17 00:00:00 2001 From: TheRoyalBlock Date: Fri, 18 Aug 2017 11:08:06 -0400 Subject: [PATCH 7/7] No more conflicts, and... Now I'm fully done. NO more conflicts, Fixed the spacing and made sections clearer Added lbsg logo --- README.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index e854cdd4c..878fb47fe 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ ## Getting Started Check out our [wiki](https://github.com/Hydreon/Steadfast2/wiki) for guides on installation for [windows](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Windows), [MacOS and Linux.](https://github.com/Hydreon/Steadfast2/wiki/Installation-on-Linux-MacOS) You will also find information on how to [stop and start the server](https://github.com/Hydreon/Steadfast2/wiki/Starting-and-Stopping-the-server), along with a detailed guide on [how to use plugins](https://github.com/Hydreon/Steadfast2/wiki/How-to-use-plugins). Remember to check out our helpful [notes](https://github.com/Hydreon/Steadfast2/wiki/Notes)-- Be sure to read these before creating a Steadfast2 phar! - - - +
+
+
### About Steadfast Steadfast is a project for backporting new Minecraft: Pocket Edition changes to older Pocketmine versions for better stability and performance, while retaining as many features from the new versions as possible. It's currently in production on Lifeboat Survival Games' main servers. Steadfast supports Pocket edition **and** Bedrock Edition (1.2+). - - - +
+
+
### How to use plugins Plugins normally come in the form of a phar file: a php archive. Steadfast2 is coded in the PHP language, and so are the plugins. To run a plugin in the form of a phar file, place the plugin into the plugins directory of the server. @@ -25,9 +25,9 @@ Steadfast2 Installation Directory
ᅠᅠᅠᅠᅠᅠ└── PluginName
ᅠᅠᅠᅠᅠᅠᅠᅠᅠ└── plugin.yml
4. Once the file structure is as shown above, you are good to go! Start the server and have fun! - - - +
+
+
### Installation on Linux and MacOS `git clone git@github.com:Hydreon/Steadfast2.git` or `https://github.com/Hydreon/Steadfast2.git` in directory of your choosing. Or download and extract zip into directory of choosing.

@@ -42,9 +42,9 @@ Running `./start` for the first time will take through a set up wizard where and #### Linux VM Notes: If using Vagrant have a config of `config.vm.network "public_network"` in the `Vagrantfile` should make your server discoverable from LAN. - - - +
+
+
### Installation on Windows 1. Install [Visual C++ Studio 2015- x64 or x86](https://www.microsoft.com/en-us/download/confirmation.aspx?id=48145) @@ -66,37 +66,37 @@ If using Vagrant have a config of `config.vm.network "public_network"` in the `V #### How to fix: Revisit the link in step 1. If you originally downloaded x86, now download x64. If you originally downloaded x64, now download x86. Install, and try again, it should now work. Contact @TheRoyalBlock if this still does not work. - - - +
+
+
### Things you'll want to do before building a phar: Saving the server.log is disabled by default, but many people would like to change this. The default MOTD for responding to MCPE server list queries is set in RaklibInterface (is currently set to Lifeboat Network). To access RaklibInterface, navigate to the Steadfast directory, then go to src-->pocketmine-->network-->RaklibInterface.php and change the motd - - - +
+
+
### Starting the server on windows Navigate to the directory in which Steadfast is installed Run the `start.cmd` file to start ### Stopping the server on windows Open the server window and type `stop` - - - +
+
+
### Starting the server on Linux/MacOS Run command ./start in from server root directory ### Stopping the server on Linux/MacOS To stop the server stop in running servers terminal. (or CTRL + C should work). - - - +
+
+
### Known bugs: Visit the [issues page](https://github.com/Hydreon/Steadfast2/issues) for a list of known bugs in Steadfast2. - - - +
+
+
### Things you'll want to change on your plugins: - Players don't fall out of the world naturally, you'll want to handle PlayerMoveEvent as needed to kill them