Skip to content
This repository has been archived by the owner on Sep 19, 2023. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Added more documentation to run the script.
  • Loading branch information
garrettsummerfi3ld committed Mar 31, 2023
1 parent 788e237 commit b086447
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,23 @@ Syncs Minecraft servers with staging and production

* wget (for downloading from the FTP server)
* This is already installed on most Linux distributions
* Python 3.6+
* On Windows, you can install it with [chocolatey](https://chocolatey.org/) by running `choco install wget`
* Python 3.8+
* API Credentials to access the FTP server and the Pterodactyl Panel
* Specific permissions needed are all files permissions and the ability to stop and start the server

## How to use

1. Clone repository
2. `cp .env.example .env`
3. Modify `.env` to your needs
4. `pip install -r requirements.txt`
5. `python3 sync.py`
2. `cp .env.example .env` to create the `.env` file
3. Modify `.env` to your specified settings
4. `pip install -r requirements.txt` to install the required Python dependencies
5. `python3 sync.py` to run the sync script

The sync script will automatically detect if the server is running or not and will stop it if it is running.

> **Note**
> Depending on the size of the server, it may take a while to sync.
## Example configuration

Expand Down

0 comments on commit b086447

Please sign in to comment.