barcomic

An HTTP API for receiving comic book barcodes from the Barcomic Android application

Barcomic App

The Barcomic application for Android and iOS (which leverages this HTTP API) is in active development and not currently publicly available. Unsure of the release date, but aiming to release before end of 2023.

Latest Releases

• Linux 64bit (barcomic-linux)
• Windows 64bit (barcomic-windows.exe)
• OS X 64bit (barcomic-darwin)

Quick Start

• Download latest release from GitHub releases page
• Double click to run the program
• This should automatically open and start the server in interactive mode, if it doesn't, open a terminal and run (e.g., ./barcomic-linux on Linux)
• Pick an IP address from the list, usually you Ethernet or Wi-Fi adapter, so the Barcomic Android app can connect to the server
• Connect the Barcomic Android app using the QR code

Command Arguments

./barcomic-linux -h
[*] barcomic v1.0.0-6b9b9a5a750be60bc8c8f33a0c3acdbd783406a3
Usage of ./barcomic-linux:
  -a string
    	IP address to listen on (default "0.0.0.0")
  -i	Run interactive configuration (default true)
  -k	Disable keystrokes
  -p string
    	Port to listen on (default "9999")
  -v	Prints verbose information

NOTE: For any of the examples provided below, change barcomic-linux to the correct release name you have downloaded. For example, barcomic-windows.exe or barcomic-darwin.

Start server with IP and port specified

Use this if you have already configured your Barcomic Android app and want to start the server using known network configuration.

./barcomic-linux -a 192.168.1.100 -p 9876

Start server without keystrokes enabled

Use this if you don't want to have the server "type" the barcode out. Good when used in verbose or logging mode.

./barcomic-linux -k -v

Build Project

Compiled binaries are provided in GitHub releases for this project. However, the following instructions provide some general guidance on building the project. The barcomic server has the following requirements:

• Go (>= 1.19)
• Make

Additionally, the robotgo Golang package is required to send barcodes as keystrokes. This package has a variety of requirements depending on the operating system. Please see the robotgo requirement documentation for platform-specific information.

If you are compiling on Linux, perform the following steps:

make install_linux_deps
make build_linux

The compiled binaries will be created in the bin folder. For more detailed information on how the project is compiled, refer to the build_* scripts in the scripts folder - where there is a script for each supported platform.