Manage, personalize, and control video chats with advanced features. 🚀

The Director's Page

Introduction

Vidlium is a simply powerful tool to bring in remote guests into software like OBS Studio. Vidlium software helps livestream directors manage guests in multiple video chats, personalize their guest’s experiences, and control video feeds with advanced settings.

Its fully browser based, uses vdo.ninja under the hood, and is open-source as well as completely free for everyone to use.

Check out some of the 'sister repos' of vidlium_director, you can find code for other parts of the website/software/system here:

• Vidlium_Website (the core website)
• Vidlium_Docs

The Directors Page is a critial page which allows directors to control a Vidlium Stream. This repository holds only the code for that page found here: https://vidlium.com/director.

Usage

To start using Vidlium, the web version (currently the only version) of the software is best. You can get started immediately at vidlium.com. The website provides access to the system as well as additional information on the code and how to do basic things via the docs & guides.

Development

Vidlium can be ran locally for developement purposes, although hosted locally, the system can still interact with streams created with the system hosted on vidlium.com.

Pre-requisites

To be able to start development on Vidlium make sure that you have the following pre-requisites installed:

• Node.js v16 or above
• Git

Starting Vidlium

1. Clone the repository and install dependencies:

git clone https://github.com/Andrew-Gallimore/vidlium_director.git && cd vidlium_director && npm install

2. Run the 'cert' script, which initiates creating SSL certificates for local domain names test.vdo.ninja and teststatic.vdo.ninja:

npm run cert

Note: When running cert, it may prompt you about needing to create a password. This is a password for the device's devcert Certificate Authority, which you will need to use if you are ever creating a new domain with devcert. In this case, you should only need to enter this once.

You only need to do this step initially after first downloading, only do step 3 for subsequent times when spinning up the dev server.

3. Run the 'start' script, which takes care of making a dev-build with gulp and creating a live reloading server for local hosting:

npm run start

The development environment should now be set up.

• Navigate to test.vdo.ninja/director (in chrome) for the directors-page with automatic reload for when you change code.

• Navigate to teststatic.vdo.ninja:8443/director (also in chrome) for the directors page without automatic reload.

Additional information on the devcert, the system used for setting up the SSL and custom domains, can be found in DEVCERT.md. Happy hacking! 👾

Contributing

Vidlium is an open-source and free project. We are committed to a fully transparent development process and highly appreciate any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as a part of the Vidlium community.

• Bug Report: If you run into an issue while using Vidlium, or are seeing unexpected behavior from the code, please create a bug report.

• Feature Request: If you have an idea or you're missing a capability that would make developement or vidlium as-a-whole easier/better, please submit a feature request.

License

A large part of this project is licensed under the GPL 3.0 license. Essentially stating that the code is required to stay open source. Be sure to check specific files, though, as some may come with a different lisense specific to that code.

README.md last updated 2/15/2024