Quick Start

Quick Start

• Quick Start
  • Install and initial setup
    • Deployment
    • Setup
      • Example
    • Create an Empty Profile
      • Arcades (Mame, and similar)
      • Other Platforms
      • Connect your front end

Install and initial setup

Deployment

NOTE: This guide assumes your config is inside /etc and your data files are inside /usr/share/ledspicerd/ if this is not the case, change the paths accordingly.
It also assumes that you are not root, so it uses sudo before commands, if you are root, remove sudo on the examples.

Follow the Deployment section to get the program installed.

Setup

Once the program is installed, and you can run ledspicerd -v and get the program version, you are ready to configure it.
If you don't have a config file or want to start ever, copy the sample config:

sudo cp /usr/share/doc/ledspicer/examples/ledspicer.conf /etc/ledspicer.conf

Edit the file /etc/ledspicer.conf and add your hardware, elements and groups.

Example

<?xml version="1.0" encoding="UTF-8"?>
<LEDSpicer
    version="1.0"
    type="Configuration"
    fps="30"
    port="16161"
    colors="basicColors"
    logLevel="Info"
    userId="1000"
    groupId="1000"
    craftProfile="true"
>
<devices>
        <device
            name="YOUR_DEVICE_NAME"
            boardId="1"
        >
            <element
                name="P1_CREDIT"
            />
            <element
                name="P1_START"
            />
            <element
                name="P1_JOYSTICK1"
            />
            <element
                name="P1_BUTTON1"
            />
            <element
                name="P1_BUTTON2"
            />
            <element
                name="P1_BUTTON3"
            />
            <element
                name="P2_CREDIT"
            />
            <element
                name="P2_START"
            />
            <element
                name="P2_JOYSTICK1"
            />
            <element
                name="P2_BUTTON1"
            />
            <element
                name="P2_BUTTON2"
            />
            <element
                name="P2_BUTTON3"
            />
        </device>
    </devices>
    <layout
        defaultProfile="default"
    >
        <group name="Player1">
            <element name="P1_CREDIT"/>
            <element name="P1_START"/>
            <element name="P1_JOYSTICK1"/>
            <element name="P1_BUTTON1"/>
            <element name="P1_BUTTON2"/>
            <element name="P1_BUTTON3"/>
        </group>
        <group name="Player2">
            <element name="P2_CREDIT"/>
            <element name="P2_START"/>
            <element name="P2_JOYSTICK1"/>
            <element name="P2_BUTTON1"/>
            <element name="P2_BUTTON2"/>
            <element name="P2_BUTTON3"/>
        </group>
</LEDSpicer>

When you finish with the hardware setup run sh ledspicerd -d to verify that you did it right and no errors are displayed.

Create an Empty Profile

Arcades (Mame, and similar)

Copy the sample empty profile into the profiles directory

sudo cp /usr/share/doc/ledspicer/examples/profile_empty.xml /usr/share/ledspicer/profiles/profile_arcade.xml

That will be the profile every arcade will use, you can change it to fit your needs like any other profile, but, it will be populated with mode data so be careful what you add there.

Other Platforms

If you need a profile for other platforms like snes, nes, genesis, etc make a copy of the template profile for each of them like this:

sudo cp /usr/share/doc/ledspicer/examples/profile_empty.xml /usr/share/ledspicer/profiles/nes.xml

change nes with any other platform name you want.
Edit the new created profile to fulfill your needs.

to test a profile run ledpicer -p profile_name, example:

ledpicer -p profile_arcade

Connect your front end

EmulatoionStation and Attract Mode are very easy to hook, follow their links to get more details.