You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,18 @@
1
1
# factorio-rcon-py
2
2
3
-
A simple factorio RCON client
3
+
A simple Factorio RCON client
4
4
5
5
## Install
6
6
7
-
`pip3 install factorio-rcon-py`
7
+
Without async support
8
+
`pip install factorio-rcon-py`
9
+
10
+
With async support
11
+
`pip install factorio-rcon-py[async]`
12
+
13
+
Async support is available as soon as the required dependency (anyio) is installed, so `pip install factorio-rcon-py anyio` is mostly equivalent, but not recommended due to dependency versioning.
All documentation is in the docstrings of each function/class. Currently,
20
-
there is no docs website or similar but one is planned.
27
+
All documentation is in the docstrings of each class/method.
21
28
22
-
Asynchronous usage of this module is possible thanks to [anyio](https://github.com/agronholm/anyio). This means that you can use the async client with asyncio, curio and trio. Use the AsyncRCONClient class. More details are in its docstring.
29
+
Asynchronous usage of this module is possible thanks to [anyio](https://github.com/agronholm/anyio). This means that you can use the async client with asyncio and trio. Use the AsyncRCONClient class. More details are in its docstring.
23
30
24
-
Available functions in both classes are (see docstrings for more info):
31
+
Available methods in both classes are (see docstrings for more info):
25
32
* connect - Connects to the RCON server.
26
33
* close - Closes the connection to the RCON server.
27
34
* send_packet - Sends a packet to the RCON server.
28
-
*receive_packets - Receives a variable number of packets from the RCON server.
35
+
*receive_packet - Receives a packet from the RCON server.
29
36
* send_command - Sends a single command to the RCON server.
30
37
* send_commands - Sends multiple commands to the RCON server.
31
38
32
-
The functions for sending/receiving packets are available in case you want to
39
+
The methods for sending/receiving packets are available in case you want to
33
40
write your own packet handlers, but in most cases you will never need to touch
0 commit comments