Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
etrusci-org committed Jul 3, 2023
1 parent 4ef9d44 commit daeb814
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ Live stream overlay stuff for use as Browser-Source in [OBS Studio](https://gith

---

## Modules

- [clock](./app/clock/): Current local date and time.
- [quotes](./app/quotes/): Random quotes.
- [rotator](./app/rotator/): Text and stuff from a list.

---

## Usage

The Base URL is: `https://etrusci-org.github.io/olay/app/`
The Base URL is: `https://etrusci-org.github.io/olay/`

1. Add Browser-Source to your Scene in OBS Studio.
2. Insert the URL to the **overlay.html** file of the module you want to use. E.g. `https://etrusci-org.github.io/olay/app/clock/overlay.html`.
3. Adjust the CSS to your liking. All the output will go inside a `<div>` with the class `mod`. Also see [default.css](./app/default.css).

---

## Modules

- **clock** ([overlay](./app/clock/overlay.html), [conf](./app/clock/conf.js)): Display current local date and time.
- **quotes** ([overlay](./app/quotes/overlay.html), [conf](./app/quotes/conf.js)): Display random quotes.
- **rotator** ([overlay](./app/rotator/overlay.html), [conf](./app/rotator/conf.js)): Display text and stuff from a list.

---

## Hosting

You can either load it from my [GitHub pages](https://etrusci-org.github.io/olay/app/) or host it on your own webserver.
You can either load it from my [GitHub pages](https://etrusci-org.github.io/olay/) or host it on your own webserver.

In any case, currently, it won't run if do not load the **overlay.html** files from a webserver. E.g. just loading it from your local filesystem won't work because of [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing).

Expand Down

0 comments on commit daeb814

Please sign in to comment.