OpenStickFirmware

<p align="center"> <a href="https://github.com/SleepUnit/OpenStickFirmware"> <img src="misc/cover.png" alt="Logo" width="100%"> </a>

<p align="center"> OpenStickFirmware is open source software designed to handle any and all tasks required in a custom Fight Stick. It can handle being the brains of your entire stick, or just handling the bells and whistles while your Brook board talks to your console. <br /> <br /> <a href="https://github.com/SleepUnit/OpenStickFirmware">Explore the Docs</a> · <a href="https://github.com/SleepUnit/OpenStickFirmware/issues">Report Bug</a> · <a href="https://github.com/SleepUnit/OpenStickFirmware/issues">Request Feature</a> </p> </p> <!-- ABOUT THE PROJECT -->

About The Project

OSF is built with CircuitPython and intended to run on any board it supports. Not only does this make the customization process friendlier for non-developers, but it also means a significant amount of power can be had for <a href="https://www.adafruit.com/product/4864">a mere four dollars</a>.

<!-- GETTING STARTED -->

Getting Started

Once you're installed CircuitPython on your device of choice, setting up OSF is as simple as downloading the files from this repository and placing them on the drive that appears on your computer.

There's no need to compile anything or download additional software.

Configuration

Basic configuration is handled in config.py. In here, you can configure whether or not your board has WS2812b (or similar) LEDs, which pins each button is connected to and so on.

Currently, the only required buttons are left, down, right and up. Anything you don't need can just be commented out.

<!-- ROADMAP -->

Roadmap

See the open issues for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information.

<!-- CONTACT -->

Contact

Jonathan Barket - jbarket@sleepunit.com

Project Link: https://github.com/SleepUnit/OpenStickFirmware

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->