Code Monkey home page Code Monkey logo

botafar's Introduction

botafar Code style: black

Add global remote controls and a real time livestream to your projects

  • Share a link and let others take the controls one by one
  • Forward the livestream to Twitch or YouTube (optional)
  • No hardware required, a phone can be used as a camera
  • Arduino and Raspberry Pi tutorials available
  • Desktop and mobile browser support, no apps, no signups

It works by decorating existing functions and class methods to respond to user input:

import botafar

j = botafar.Joystick("W","A","S","D")

@j.on_left
def turn_left():
    print("left!")

@j.on_right
def turn_right():
    print("right!")

# [email protected]_up, on_down, on_center

botafar.run()

result

Check botafar.com for currently online bots!

Get started

Starting scenario

Let's suppose you have a Python project, main.py, where you have defined two functions greet and target:

def greet():
    print("hello")

def target():
    print("world")

greet()
target()

When you run main.py it calls those functions, and prints "hello" and "world" to the terminal:

$ python main.py
hello
world

You want be able to share a link through which people can remotely call these functions on your hardware, and see the results in real life through a low-latency livestream (and optionally, on Twitch or YouTube as well).

botafar enables you to do all these things.

Add remote controls and livestreaming

  1. Install the library (help)
pip install --upgrade botafar

On some Debian based operating systems such as Raspberry Pi OS, on you need to have libSRTP and other related network dependencies installed to be installed as well: sudo apt install libnss3 libnspr4 libsrtp2-1 -y

  1. Modify main.py:
  • Import botafar
  • Create a control, Joystick in this example, and bind 4 keys from keyboard to it
  • Use decorators (@-symbol) to select functions to call on user input
  • Call botafar.run()
import botafar

j = botafar.Joystick("W","A","S","D")

@j.on_left
def greet():
    print("hello")

@j.on_right
def target():
    print("world")

botafar.run()
  1. Execute the main.py file, and open the returned link in browser. Note that this browser can be on other device, for example the Python program can run on a Raspberry Pi and the browser setup is done on a desktop PC's browser (help).
$ python main.py

Bot running, connect at https://botafar.com/abcde-fghij-klmno
  1. From the browser, press the Try controls -button. Now when you press A and D keys from a keyboard or a touch screen, texts "hello" and "world" get printed on terminal.
$ python main.py

Bot running, connect at https://botafar.com/abcde-fghij-klmno
hello
world
hello
world
  1. Choose a stream source from the browser. It can be a webcam, a phone or a screen share (help).

  2. Give your bot a name and switch it to public

  3. The browser now shows a direct link to your bot you can share with anyone in the world! Others can press keyboard or touch screen to print "hello" and "world" to the terminal, and see the prints through a low-latency livestream.

If you got stuck, have an idea or you found a bug, write about it on the GitHub discussions forum. This tool is still under development, and all feedback is appreciated.

Keep reading if you want to learn how to:

botafar's People

Contributors

ollipal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.