Skip to content

Commit 1cc0b95

Browse files
author
Ricardo Band
committed
Merge branch 'master' of github.com:c-base/pymlgame
2 parents 446e6bd + 53d01f8 commit 1cc0b95

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,28 @@ This is the coitus protocol that handles the communication between the game and
3535
Controller -> Game
3636
------------------
3737

38-
### /controller/new/<port>
38+
### /controller/new/&lt;port&gt;
3939

40-
Connect a new controller to the game. Game will answer with /uid/<uid>. This is also known as 'anpymln'.
40+
Connect a new controller to the game. Game will answer with /uid/&lt;uid&gt;. This is also known as 'anpymln'.
4141

42-
### /controller/<uid>/ping/<port>
42+
### /controller/&lt;uid&gt;/ping/&lt;port&gt;
4343

4444
Tell the game that the controller is still in use and update it's address and port. Use this once a minute or the
4545
controller will get deleted.
4646

47-
### /controller/<uid>/kthxbye
47+
### /controller/&lt;uid&gt;/kthxbye
4848

4949
Disconnect the controller properly. In theory you could just wait 60s but this is the cleaner way and most games would
5050
be very happy if you use this.
5151

52-
###/controller/<uid>/states/<states>
52+
###/controller/&lt;uid&gt;/states/&lt;states&gt;
5353

5454
Send the states of your controller keys. Always send all 14 states, even if your controller doesn't have 14 buttons.
5555
The states should be an array with 0 for key not pressed and 1 for key pressed. So if you're pressing the Up button and
5656
X the states array should look like this: 10000010000000
5757
You can lookup all possible buttons and there location in the array in pymlgame/locals.py.
5858

59-
### /controller/<uid>/text/<text>
59+
### /controller/&lt;uid&gt;/text/&lt;text&gt;
6060

6161
*Optional*
6262

@@ -67,24 +67,24 @@ without this function but you can use it if your controller is capable of text i
6767
Game -> Controller
6868
------------------
6969

70-
### /uid/<uid>
70+
### /uid/&lt;uid&gt;
7171

7272
Tell the controller its uid. This is ideally an integer.
7373

74-
### /rumble/<duration>
74+
### /rumble/&lt;duration&gt;
7575

7676
*Optional*
7777

7878
Tell the controller to rumble. Duration should be given in milliseconds. Not all controllers have the ability to rumble.
7979
Maybe they do it in an optical way.
8080

81-
### /message/<text>
81+
### /message/&lt;text&gt;
8282

8383
*Optional*
8484

8585
Send some text to the controller. Be aware that not all controllers can display text, so don't send important things.
8686

87-
### /download/<url>
87+
### /download/&lt;url&gt;
8888

8989
*Optional*
9090

@@ -93,7 +93,7 @@ file so that the player can hear some ingame sounds. Use this function everytime
9393
could have deleted the files after playing. Controllers should ensure that files already downloaded gets downloaded
9494
again to reduce loading times for games that have been played before.
9595

96-
### /play/<file>
96+
### /play/&lt;file&gt;
9797

9898
*Optional*
9999

0 commit comments

Comments
 (0)