Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lpuv authored Mar 26, 2019
1 parent 763429f commit 8e62fe1
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ Server available at: 0.tcp.ngrok.io:17003
Copy the `0.tcp.ngrok.io:17003` part, and paste it into your local Minecraft app
as the server name.

## Syncing to S3
## Syncing to Dropbox or S3

The Heroku filesystem is [ephemeral](https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem),
which means files written to the file system will be destroyed when the server is restarted.

Minecraft keeps all of the data for the server in flat files on the file system.
Thus, if you want to keep you world, you'll need to sync it to S3.
Thus, if you want to keep you world, you'll need to sync it to S3 or Dropbox.

First, create an [AWS account](https://aws.amazon.com/) and an S3 bucket. Then configure the bucket
and your AWS keys like this:
Expand All @@ -60,6 +60,15 @@ $ heroku config:set AWS_ACCESS_KEY=xxx
$ heroku config:set AWS_SECRET_KEY=xxx
```

For Dropbox, use this:

Create a Dropbox account.
Copy your Dropbox access token following these [instructions](https://blogs.dropbox.com/developers/2014/05/generate-an-access-token-for-your-own-account/).

```
$ heroku conig:set DROPBOX_ACCESS_TOKEN=xxx
```

The buildpack will sync your world to the bucket every 60 seconds, but this is configurable by setting the `AWS_SYNC_INTERVAL` config var.

## Connecting to the server console
Expand Down Expand Up @@ -88,6 +97,8 @@ You can customize ngrok by setting the `NGROK_OPTS` config variable. For example
$ heroku config:set NGROK_OPTS="--remote-addr 1.tcp.ngrok.io:25565"
```

**NOTE** You can only set the remote address or custom subdomain if you have a Pro or Business ngrok account.

### Minecraft

You can choose the Minecraft version by setting the MINECRAFT_VERSION like so:
Expand All @@ -103,3 +114,4 @@ described on the [Minecraft Wiki](http://minecraft.gamepedia.com/Server.properti

You can add files such as `banned-players.json`, `banned-ips.json`, `ops.json`,
`whitelist.json` to your Git repository and the Minecraft server will pick them up.
You can also add plugins. First, make a directory called plugins. Make sure you check if the plugin is compatible with your minecraft version, and copy them into the plugins folder.

0 comments on commit 8e62fe1

Please sign in to comment.