openfixturelibrary

Open Fixture Library

A free library of DMX enabled devices
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

There are so many DMX fixtures out there; however, I couldn't find any free libraries that really suited my needs, and had all the information I required. So I created this one. I want to create a repository of fixtures so vast and informative that it'll be the last one you ever need!

Here's why:

• Your time should be focused on creating something amazing.
• You shouldn't be wasting time researching and building your own massive library of fixtures

Of course, this repository won't be able to contain every fixture ever! So I'll be adding more and more as much as I can. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

Built With

This library was built by hand, by real people (so there might be a few mistakes). Feel free to suggest a change or open an issue if you spot any.

There are no libraries or frameworks used, it's just pure json data. An NPM module and online API will be available in the near future.

(back to top)

Getting Started

• Using NPM

  npm install openfixturelibrary

• Directly from Github

  git clone https://github.com/danielfar-theatretech/OpenFixtureLibrary.git

(back to top)

Usage

All profiles are separated into their own files, so you can use them as-is if you wish.

Or if you are using the NPM module, fixtures are contained within objects named after the manufacturer.

• e.g.

const OpenFixtureLibrary = require("openfixturelibrary");
const myProfile = OpenFixtureLibrary.Fixtures.Equinox.FusionSpotMKII;

(back to top)

Roadmap

• [ ] Create Changelog
• [ ] Increase number of supported fixtures
• [ ] Include physical dimensions
• [ ] Include links to manufacturers page, specification, demo videos etc

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

No official contact information yet, sorry if this inconveniences you.

Project Link: https://github.com/danielfar-theatretech/OpenFixtureLibrary

(back to top)

Acknowledgments

No-one to put here yet, but your name could be featured!

(back to top)