diff options
| author | destruc7i0n <destruc7i0n@users.noreply.github.com> | 2017-06-03 10:15:00 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-03 10:15:00 -0400 |
| commit | e8525b32420dac7fe9d25b6787c4e96383144ad1 (patch) | |
| tree | d069888ddae6a358022f567e9ef01de3ad554e18 | |
| parent | Update gif link (diff) | |
| download | shulker-e8525b32420dac7fe9d25b6787c4e96383144ad1.tar.gz shulker-e8525b32420dac7fe9d25b6787c4e96383144ad1.zip | |
Update readme
* Made the command wording a little more understandable * Remove TRAVIS * Remove "Upcoming" as the official API has come and this is not easily doable
| -rw-r--r-- | README.md | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md index dbf1022..aa4811b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # shulker [](https://david-dm.org/destruc7i0n/shulker) -[](https://travis-ci.org/destruc7i0n/shulker) [](https://circleci.com/gh/destruc7i0n/shulker) > Connects [Discord](https://discordapp.com/) and [Minecraft](https://minecraft.net) Servers by sending messages back and forth without any mods or plugins. @@ -11,25 +10,26 @@ ## Installation and usage -In your Minecraft server.properties, make sure you have: +In your Minecraft server.properties, make sure you have and restart the server: ``` enable-rcon=true rcon.password=<your password> rcon.port=<1-65535> ``` -Run the following on your server hosting (in a screen/tmux session or background process, and make sure to replace your URL and your log directory location): - -``` sh -tail -F /PATH_TO_MINECRAFT_INSTALL/logs/latest.log | grep --line-buffered ": <" | while read x ; do echo -ne $x | curl -X POST -d @- https://YOUR_URL/minecraft/hook ; done -``` - Clone repository onto a server, edit ```config.json``` (see below for more info) and change any options, and then, in the repository folder: ```sh $ npm install $ npm start ``` -You can also easily Deploy to Heroku or Bluemix. + +Run the following on your server hosting (in a screen/tmux session or background process, make sure to replace your `YOUR_URL` with whatever URL you're using (`localhost:8000` if running on the same server and default config) and `PATH_TO_MINECRAFT_INSTALL` with the path to the Minecraft server installation, such as `/usr/home/minecraft_server/`): + +``` sh +tail -F /PATH_TO_MINECRAFT_INSTALL/logs/latest.log | grep --line-buffered ": <" | while read x ; do echo -ne $x | curl -X POST -d @- http://YOUR_URL/minecraft/hook ; done +``` + +You can also easily Deploy to Heroku or Bluemix, just be sure to edit `YOUR_URL` in the command to match accordingly. [](https://heroku.com/deploy) [](https://bluemix.net/deploy?repository=https://github.com/destruc7i0n/shulker) @@ -59,8 +59,7 @@ $ npm test ``` ## Upcoming -* A "merge accounts" function to allow Minecraft players to associate their Discord accounts with their Minecraft accounts so that usernames are accurate -* Ability to post messages to Discord on behalf of Discord users, rather than using a bot user (hopefully after the official API is released) +None ## Suggestions If you have any suggestions or feature requests, feel free to add an issue and I will take a look and possibly add it to the "Upcoming" section! |