Skip to content

Commit b7691ee

Browse files
committed
Improve readme
1 parent 1a57555 commit b7691ee

1 file changed

Lines changed: 21 additions & 11 deletions

File tree

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
11
# Memory Plugin for Minecraft
2-
--------------------------------------------------
32
You have a boring serverlobby or just want to play memory in minecraft?
43
Try our version of memory in minecraft,
54
because our plugin brings variety in your serverlobby.
5+
66
## Features
77
* unique minigame
88
* awesome gui with beautiful animations
99
* easy to configure
1010
* works out of the box
1111
* varying themes
12+
1213
## Setup
13-
* Put the [`Memory.jar`](https://www.spigotmc.org/resources/45082/download?version=176527) in your plugin folder
14-
* Start the server and wait until the message file was created
14+
* Put the [`memory.jar`](https://github.com/WeLoveOpenSourcePlugins/memory/releases/latest) in your plugin folder
15+
* Start the server and wait until the message file got created
1516
* Customize the messages (messages.yml)
16-
* Start you're server again and connect
17+
* Start your server again and connect
18+
1719
## How to play
1820
Right-click the customized block (default: noteblock) to join the queue or use /memory. If a second player joins the queue, the game will start.
1921
Leave the game by closing the inventory.
2022

2123
## Configuration
2224
##### config.yml
23-
----------------
24-
```
25+
26+
```yaml
2527
join_per_block: false
26-
join_block_id: '25:0'
28+
join_block: 'NOTE_BLOCK'
2729
```
30+
2831
##### messages.yml
29-
----------------
30-
```
32+
33+
```yaml
3134
tag: '&8[&eMemory&8]'
3235
game:
3336
against: '%tag% &7You are playing against &e%player%&7.'
@@ -45,11 +48,18 @@ result:
4548
draw: '%tag% &eDraw! - Nobody won.'
4649
win: '%tag% &e%player% has won the game. (%score% pairs)'
4750
```
51+
4852
## Pictures
4953
[![YouTube Gameplay](https://img.youtube.com/vi/-aDJW23rj88/0.jpg)](http://www.youtube.com/watch?v=-aDJW23rj88)
5054
![Queue](https://image.prntscr.com/image/NN0lUvmUTcyjvZx91S-WYw.png)
5155
![GUI](https://image.prntscr.com/image/EUy4z29UT0GKME8PcWXpYQ.png)
5256
-----------------------------
57+
5358
## Problems during installation?
54-
Just write a PM to [@Paul2708](https://www.spigotmc.org/members/paul2708.44827/) on Spigot or contact me via Twitter ([@theplayerpaul](https://twitter.com/theplayerpaul)), Discord or Skype.
55-
Thank you for your attention.
59+
Just write a PM to [@Paul2708](https://www.spigotmc.org/members/paul2708.44827/) on Spigot or contact me via Twitter ([@theplayerpaul](https://twitter.com/theplayerpaul)) or Discord (Paul2708#1098).
60+
Thank you for your attention.
61+
62+
## Contribute
63+
If you find any bugs or want to contribute, just open an issue! We would appreciate it.
64+
65+
> WeLoveOpenSourcePlugins :heart:

0 commit comments

Comments
 (0)