Skip to content

Commit 66838d8

Browse files
committed
Ranmed to bec_rcon.py - Build proper package
1 parent 0ea0da1 commit 66838d8

File tree

9 files changed

+74
-547
lines changed

9 files changed

+74
-547
lines changed

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include LICENSE

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
# API and Discord Module for BEC RCon
22

33
# Install
4-
5-
API: Download rcon.py and simply import it.
6-
Discord: Download all files and add discord_module.py to your bot as [Cogs](https://discordpy.readthedocs.io/en/latest/ext/commands/cogs.html).
7-
Example Structure:
8-
discord_bot/
9-
├── bot.py (Your discord bot)
10-
├── modules/
11-
│ └── rcon/
12-
│ ├── __init__.py
13-
│ ├── module.py
14-
│ ├── rcon.py
15-
│ └── rcon_cfg.json
4+
Install via pip:
5+
```
6+
pip install git+https://github.com/Yoshi-E/Python-BEC-RCon.git
7+
```
8+
Alternatively you can download the python wheel and install it with:
9+
```
10+
pip install bec_rcon-0.1.0-py3-none-any.whl
11+
```
1612

1713
# Demo
1814
Check out the full demo in api_example.py.
@@ -22,8 +18,8 @@ This short example connects to a RCon server and prints all server messages it r
2218
def msg(message):
2319
print(message)
2420

25-
import rcon
26-
rcon_client = rcon.ARC("192.168.0.1", "MyPassword", 2302)
21+
import bec_rcon
22+
rcon_client = bec_rcon.ARC("192.168.0.1", "MyPassword", 2302)
2723
rcon_client.add_Event("received_ServerMessage", msg)
2824

2925
```
@@ -34,6 +30,11 @@ rcon_client.add_Event("received_ServerMessage", msg)
3430
Join my Discord: https://discordapp.com/invite/YhBUUSr
3531
Bohemia Interactive Forum Thread: https://forums.bohemia.net/forums/topic/223835-api-bec-rcon-api-for-python-and-discord/
3632

33+
# Discord:
34+
35+
A Discord module using this API can be found here:
36+
https://github.com/Yoshi-E/jmwBOT/tree/master/modules/rcon
37+
3738
# Documentation
3839
## Event Handlers:
3940
The passed functions can by async and can be class objects.

__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
from . import rcon
1+
name = "bec_rcon"
File renamed without changes.

0 commit comments

Comments
 (0)