Skip to content

Commit fd2203b

Browse files
authored
Update README.md
1 parent 395efff commit fd2203b

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Build](https://github.com/versx/ChuckDeviceController/workflows/.NET%20Core/badge.svg)](https://github.com/versx/ChuckDeviceController/actions)
2+
[![GitHub Release](https://img.shields.io/github/release/versx/ChuckDeviceController.svg)](https://github.com/versx/ChuckDeviceController/releases/)
13
[![GitHub Contributors](https://img.shields.io/github/contributors/versx/ChuckDeviceController.svg)](https://github.com/versx/ChuckDeviceController/graphs/contributors/)
24
[![Discord](https://img.shields.io/discord/552003258000998401.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/zZ9h9Xa)
35
# Chuck Device Controller
@@ -16,8 +18,9 @@ ChuckDeviceController is a C# based backend using Redis, ASP.NET Core, and Entit
1618
- MariaDB 10.5
1719

1820
## How It Works
19-
There are 3 parts to it:
20-
- ChuckDeviceController which will control devices, parse incoming protos, and device management dashboard UI.
21+
There are 4 parts to it:
22+
- ChuckDeviceController which will control devices and includes the device management dashboard UI.
23+
- ChuckProtoParser parses any raw incoming proto data and relays to Redis.
2124
- DataConsumer will insert or upsert data from the redis queue containing parsed protos to consume with MySQL.
2225
- WebhookProcessor controls and filters webhooks and where to send newly updated events (Pokemon, Raids, etc).
2326

@@ -59,9 +62,10 @@ https://download.visualstudio.microsoft.com/download/pr/a06c387d-2811-4fba-8b5f-
5962
1. Fill out `config.json`
6063
1. Build project from root folder `~/.dotnet/dotnet build`
6164
1. Run ChuckDeviceController from `bin/` folder `~/.dotnet/dotnet ChuckDeviceController.dll`
62-
1. Run WebhookProcessor from `bin/` folder `~/.dotnet/dotnet WebhookProcessor.dll`
63-
1. Run DataConsumer from `bin/` folder `~/.dotnet/dotnet DataConsumer.dll` or use [Chuck](https://github.com/WatWowMap/Chuck) as the backend data consumer.
64-
1. Visit Dashboard at `http://LAN_MACHINE_IP:5001`
65+
1. Run ChuckProtoParser from `bin/` folder `~/.dotnet/dotnet ChuckProtoParser.dll`
66+
3. Run WebhookProcessor from `bin/` folder `~/.dotnet/dotnet WebhookProcessor.dll`
67+
4. Run DataConsumer from `bin/` folder `~/.dotnet/dotnet DataConsumer.dll` or use [Chuck](https://github.com/WatWowMap/Chuck) as the backend data consumer.
68+
5. Visit Dashboard at `http://LAN_MACHINE_IP:5001`
6569

6670
View all available API routes:
6771
`http://LAN_MACHINE_IP:port/swagger`
@@ -74,9 +78,13 @@ View profiler results:
7478
```json
7579
{
7680
// Change to machine IP address
77-
"interface": "LAN_MACHINE_IP",
78-
// Listening port to receive data and control devices
79-
"port": 5001,
81+
"controllerInterface": "LAN_MACHINE_IP",
82+
// Listening port to control devices
83+
"controllerPort": 5000,
84+
// Change to machine IP address
85+
"parserInterface": "LAN_MACHINE_IP",
86+
// Listening port to receive raw proto data
87+
"parserPort": 5000,
8088
// Database information
8189
"db": {
8290
// Database host/IP address
@@ -111,3 +119,4 @@ View profiler results:
111119
- Finish MAD support
112120
- User management system for UI
113121
- Token/IP whilelist auth
122+
- Environment variables

0 commit comments

Comments
 (0)