DARTS-PIXELIT

Darts-pixelit controls your pixelit-installation(s) https://github.com/pixelit-project/PixelIt accordingly to the state of an https://autodarts.io game. A running instance of https://github.com/lbormann/darts-caller is needed that sends thrown points from https://autodarts.io to this application.

Special thanks to user Sini. He came up with the funny idea and developed the core code for controlling a Pixelit installation.

COMPATIBILITY

Variant	Support
X01	✔️
Cricket	✔️
Bermuda
Shanghai
Gotcha
Around the Clock
Round the World
Random Checkout	✔️
Count Up
Segment Training

Showcase

Videos (Click to play):

Images:

COMING SOON

Hardware

Here is my currrent Hardware-Setup (You can google prices yourself):

Controller: 1x AZDelivery ESP32 D1 Mini
LED-Matrix: 1x WS2812B RGB Flexible FCB Vollfarb-Pixelmatrix, 8x32 Pixels
Power adapter: 1x Mean Well LPV-60-5 40W 5V, 8AMP DC

INSTALL INSTRUCTION

Desktop-OS:

If you're running a desktop-driven OS it's recommended to use darts-hub as it takes care of starting, updating, configurating and managing multiple apps.

Headless-OS:

Download the appropriate executable in the release section.

By Source:

Setup python3

Download and install python 3.x.x for your specific os.
Download and install pip.

Get the project

git clone https://github.com/lbormann/darts-pixelit.git

Go to download-directory and type:

pip3 install -r requirements.txt

RUN IT

Prerequisite

You need to have a running caller - https://github.com/lbormann/darts-caller - (latest version)
You need to have a running PIXELIT-Installation (2.5.0 at minimum required)

Run by executable

Example: Windows

Create a shortcut of the executable; right click on the shortcut -> select properties -> add arguments in the target input at the end of the text field.

Example: C:\Downloads\darts-pixelit.exe -PEPS "your-first-pixelit-ip" "your-second-pixelit-ip" -TP "absolute-path-to-your-template-files"

Save changes. Click on the shortcut to start the application.

Run by source

Example: Linux

python3 darts-pixelit.py -PEPS "your-pixelit-ip" -TP "absolute-path-to-your-template-files"

Arguments

-CON / --connection [OPTIONAL] [Default: "127.0.0.1:8079"]
-PEPS / --pixel_endpoints [REQUIRED] [MULTIPLE ENTRIES POSSIBLE]
-TP / --templates_path [REQUIRED]
-BRI / --effect_brightness [OPTIONAL] [Default: 20] [Possible values: 1 .. 255]
-HFO / --high_finish_on [OPTIONAL] [Default: None] [Possible values: 2 .. 170]
-HF / --high_finish_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-AS / --app_start_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-IDE / --idle_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-GS / --game_start_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-MS / --match_start_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-G / --game_won_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-M / --match_won_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-B / --busted_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-PJ / --player_joined_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-PL / --player_left_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-S{0-180} / --score_{0-180}_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]
-A{1-12} / --score_area_{1-12}_effects [OPTIONAL] [MULTIPLE ENTRIES POSSIBLE] [Default: None] [Possible values: See below]

-CON / --connection

Host address to data-feeder (darts-caller). By Default this is '127.0.0.1:8079' (means your local ip-address / usually you do NOT need to change this)

-PEPS / --pixelit_endpoints

IP to your PIXELIT. You can define multiple entries. For example: '192.168.3.200' '192.168.3.201'.

-TP / --templates_path

Setup an absolute path where your templates (*.json) are located. Make sure the given path doesn't reside inside main-directory (darts-pixelit).

-BRI / --effect_brightness

Brightness for PIXELIT-effects. You can choose a value between '1' and '255'. By default this is 20.

-HFO / --high_finish_on

Define what a highfinish means for you. Choose a score-value between '2' and '170'. This value is relevant for argument '-HF'. By default this is not set = no effects for 'Highfinishes'.

-HF / --high_finish_effects

Controls your pixelit(s) when a high-finish occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-AS / --app_start_effects

Controls your pixelit(s) when the application starts Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-IDE / --idle_effects

Controls your pixelit(s) when dart-pulling occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-GS / --game_start_effects

Controls your pixelit(s) when a game-start occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-MS / --match_start_effects

Controls your pixelit(s) when a match-start occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-G / --game_won_effects

Controls your pixelit(s) when a game won occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-M / --match_won_effects

Controls your pixelit(s) when a match won occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-B / --busted_effects

Controls your pixelit(s) when a bust occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-PJ / --player_joined_effects

Controls your pixelit(s) when a player-join occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-PL / --player_left_effects

Controls your pixelit(s) when a player-left occurs. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-S{0-180} / --score_{0-180}_effects

Controls your pixelit(s) when a specific score occurs. You can define every score-value between 0 and 180. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

-A{1-12} / --score_area_{1-12}_effects

Besides the definition of single score-values you can define up to 12 score-areas. Define one template or a list. If you define a list, the program will display templates one after another. See examples below!

Examples:

Argument	[condition]	template 1	template 2	template 3	...
-AS		call\|t:Lets{}Play{}Darts{}-==-<
-G		board\|t:Gameshot!{}{playername}{}-{}{score}
-A1	0-15	points-bad
-A2	16-60	points-ok
-B		dart\|d:200\|b:10	dart0\|d:200\|b:20	dart1\|d:200\|b:30	dart2\|b:50

The first argument-definition shows the event 'App-start': on app start, a template-file with name 'call.json' will be displayed with a text 'Lets Play Darts -==-<'. Notice '{}' (curly braces) in the argument definition: It's a placeholder for an empty space character in the given text (t:). This rule applies on every text of an argument-definition. So.. you can't define an argument-text with 'call|t:Lets Play Darts -==-<'. That won't work properly.
The second argument-definition shows the event 'Gameshot': on gameshot, a template-file with name 'board.json' will be displayed. Moreover a text 'Gameshot! Playername - Finish-score' will be displayed. Notice '{playername}' and {'score'}. Those are valid text-variables for the gameshot-event. Those variables will be replaced on runtime with corresponding values. You can find a list of available text-variables here.
The third argument-definition shows a 'score-area': recognized scores between 0 and 15 will result in displaying template 'points-bad'
The fourth argument-definition shows a 'score-area': recognized scores between 16 and 60 result in displaying template 'points-ok'
The fifth argument-definition shows the event 'Busted': Busting will result in displaying templates in order you define them (dart, dart0, dart1, ...). The value 'd:200' defines 200ms delay between current and next template. The value 'b:10' defines custom brightness for a template.
If you don't understand have a look at the example file!

learn at: start.bat

Text-variables

Argument	Variables
-HF	{playername}, {score}
-AS
-IDE	{playername}, {points-left}
-MS	{game-mode}, {game-mode-extra}, {playername}
-GS	{game-mode}, {game-mode-extra}, {playername}
-G	{playername}, {score}
-M	{playername}, {score}
-B
-PJ	{playername}
-PL	{playername}
-S(1-180)	{playername}, {score}
-A(1-12)	{playername}, {score}

Community-Profiles

Argument	USER#1234	USER#1234	USER#1234
COMING SOON

Moreover you can find ready-to-go pixelit-templates in the community-folder.

!!! IMPORTANT !!!

This application requires a running instance of darts-caller https://github.com/lbormann/darts-caller

lbormann / darts-pixelit