From 7124a0412470faa39b65f503655f525a31658919 Mon Sep 17 00:00:00 2001 From: arT2 <60965610+etrusci-org@users.noreply.github.com> Date: Tue, 11 Jul 2023 10:35:36 +0200 Subject: [PATCH] Examples before config --- README.md | 2 -- app/mod/clock.md | 20 ++++++++++---------- app/mod/colorfader.md | 20 ++++++++++---------- app/mod/numbers.md | 22 +++++++++++----------- app/mod/quotes.md | 16 ++++++++-------- app/mod/rotator.md | 18 +++++++++--------- 6 files changed, 48 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index bfd4e82..4be45e1 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ Live stream overlay stuff for use as Browser-Source in [OBS Studio](https://gith - [quotes](./app/mod/quotes.md) - [rotator](./app/mod/rotator.md) -Each module documentation contains examples. - --- ## Notes diff --git a/app/mod/clock.md b/app/mod/clock.md index 7a4fb00..1c38968 100644 --- a/app/mod/clock.md +++ b/app/mod/clock.md @@ -7,6 +7,16 @@ Display current local date and time. --- +## Examples + +- [mod=clock](https://etrusci.org/tool/olay/?mod=clock) +- [mod=clock&humanformat={hour}:{minute}&updaterate=60000](https://etrusci.org/tool/olay/?mod=clock&humanformat={hour}:{minute}&updaterate=60000) +- [mod=clock&repnum=true&repmap=4](https://etrusci.org/tool/olay/?mod=clock&repnum=true&repmap=4) +- [mod=clock&type=unix](https://etrusci.org/tool/olay/?mod=clock&type=unix) +- [mod=clock&type=unixms&updaterate=80](https://etrusci.org/tool/olay/?mod=clock&type=unixms&updaterate=80) + +--- + ## Configuration ### updaterate @@ -50,13 +60,3 @@ Valid: `1` | `2` | `3` | `4` | `5` See [replaceNumsWithChars()](../lib/olay.js) for map contents. --- - -## Examples - -- [mod=clock](https://etrusci.org/tool/olay/?mod=clock) -- [mod=clock&humanformat={hour}:{minute}&updaterate=60000](https://etrusci.org/tool/olay/?mod=clock&humanformat={hour}:{minute}&updaterate=60000) -- [mod=clock&repnum=true&repmap=4](https://etrusci.org/tool/olay/?mod=clock&repnum=true&repmap=4) -- [mod=clock&type=unix](https://etrusci.org/tool/olay/?mod=clock&type=unix) -- [mod=clock&type=unixms&updaterate=80](https://etrusci.org/tool/olay/?mod=clock&type=unixms&updaterate=80) - ---- diff --git a/app/mod/colorfader.md b/app/mod/colorfader.md index 5117992..2f82012 100644 --- a/app/mod/colorfader.md +++ b/app/mod/colorfader.md @@ -7,6 +7,16 @@ Display and fade tru colors. --- +## Examples + +- [mod=colorfader](https://etrusci.org/tool/olay/?mod=colorfader) +- [mod=colorfader&duration=5](https://etrusci.org/tool/olay/?mod=colorfader&duration=5) +- [mod=colorfader&duration=5&function=ease-out](https://etrusci.org/tool/olay/?mod=colorfader&duration=5&function=ease-out) +- [mod=colorfader&duration=5&random=false](https://etrusci.org/tool/olay/?mod=colorfader&duration=5&random=false) +- [mod=colorfader&duration=5&random=false&list=|ff0000|00ff00|0000ff&shuffle=true](https://etrusci.org/tool/olay/?mod=colorfader&duration=5&random=false&list=|ff0000|00ff00|0000ff&shuffle=true) + +--- + ## Configuration ### delay @@ -49,13 +59,3 @@ Requires: `random=false` Valid: `true` | `false` --- - -## Examples - -- [mod=colorfader](https://etrusci.org/tool/olay/?mod=colorfader) -- [mod=colorfader&duration=5](https://etrusci.org/tool/olay/?mod=colorfader&duration=5) -- [mod=colorfader&duration=5&function=ease-out](https://etrusci.org/tool/olay/?mod=colorfader&duration=5&function=ease-out) -- [mod=colorfader&duration=5&random=false](https://etrusci.org/tool/olay/?mod=colorfader&duration=5&random=false) -- [mod=colorfader&duration=5&random=false&list=|ff0000|00ff00|0000ff&shuffle=true](https://etrusci.org/tool/olay/?mod=colorfader&duration=5&random=false&list=|ff0000|00ff00|0000ff&shuffle=true) - ---- diff --git a/app/mod/numbers.md b/app/mod/numbers.md index ea3ebc3..9d179e1 100644 --- a/app/mod/numbers.md +++ b/app/mod/numbers.md @@ -7,6 +7,17 @@ Display random numbers and counters. --- +## Examples + +- [mod=numbers](https://etrusci.org/tool/olay/?mod=numbers) +- [mod=numbers&updaterate=2000](https://etrusci.org/tool/olay/?mod=numbers&updaterate=2000) +- [mod=numbers&updaterate=1000&type=countup](https://etrusci.org/tool/olay/?mod=numbers&updaterate=1000&type=countup&start=0&end=10) +- [mod=numbers&updaterate=1000&type=countdown](https://etrusci.org/tool/olay/?mod=numbers&updaterate=1000&type=countdown&start=10&end=0) +- [mod=numbers&updaterate=1000&type=countup&end=none](https://etrusci.org/tool/olay/?mod=numbers&updaterate=1000&type=countup&end=none) +- [mod=numbers&repnum=true&repmap=4](https://etrusci.org/tool/olay/?mod=numbers&repnum=true&repmap=4) + +--- + ## Configuration ### updaterate @@ -49,14 +60,3 @@ Valid: `1` | `2` | `3` | `4` | `5` See [replaceNumsWithChars()](../lib/olay.js) for map contents. --- - -## Examples - -- [mod=numbers](https://etrusci.org/tool/olay/?mod=numbers) -- [mod=numbers&updaterate=2000](https://etrusci.org/tool/olay/?mod=numbers&updaterate=2000) -- [mod=numbers&updaterate=1000&type=countup](https://etrusci.org/tool/olay/?mod=numbers&updaterate=1000&type=countup&start=0&end=10) -- [mod=numbers&updaterate=1000&type=countdown](https://etrusci.org/tool/olay/?mod=numbers&updaterate=1000&type=countdown&start=10&end=0) -- [mod=numbers&updaterate=1000&type=countup&end=none](https://etrusci.org/tool/olay/?mod=numbers&updaterate=1000&type=countup&end=none) -- [mod=numbers&repnum=true&repmap=4](https://etrusci.org/tool/olay/?mod=numbers&repnum=true&repmap=4) - ---- diff --git a/app/mod/quotes.md b/app/mod/quotes.md index 1cf9545..8cb3593 100644 --- a/app/mod/quotes.md +++ b/app/mod/quotes.md @@ -7,6 +7,14 @@ Display random quotes. --- +## Examples + +- [mod=quotes](https://etrusci.org/tool/olay/?mod=quotes) +- [mod=quotes&updaterate=20000](https://etrusci.org/tool/olay/?mod=quotes&updaterate=20000) +- [mod=quotes&typingspeed=30](https://etrusci.org/tool/olay/?mod=quotes&typingspeed=40) + +--- + ## Configuration ### updaterate @@ -22,11 +30,3 @@ Speed of the typing effect in milliseconds. Valid: *Integers >= 1* --- - -## Examples - -- [mod=quotes](https://etrusci.org/tool/olay/?mod=quotes) -- [mod=quotes&updaterate=20000](https://etrusci.org/tool/olay/?mod=quotes&updaterate=20000) -- [mod=quotes&typingspeed=30](https://etrusci.org/tool/olay/?mod=quotes&typingspeed=40) - ---- diff --git a/app/mod/rotator.md b/app/mod/rotator.md index 2cec9e8..a3d362a 100644 --- a/app/mod/rotator.md +++ b/app/mod/rotator.md @@ -7,6 +7,15 @@ Display and rotate tru text from a list. --- +## Examples + +- [mod=rotator](https://etrusci.org/tool/olay/?mod=rotator) +- [mod=rotator&updaterate=2000](https://etrusci.org/tool/olay/?mod=rotator&updaterate=2000) +- [mod=rotator&updaterate=2000&items=|one|two|three](https://etrusci.org/tool/olay/?mod=rotator&updaterate=2000&items=|one|two|three) +- [mod=rotator&updaterate=2000&items=|one|two|three&shuffle=false](https://etrusci.org/tool/olay/?mod=rotator&updaterate=2000&items=|one|two|three&shuffle=false) + +--- + ## Configuration ### updaterate @@ -30,12 +39,3 @@ Valid: *text, HTML* Start each item with `|`. --- - -## Examples - -- [mod=rotator](https://etrusci.org/tool/olay/?mod=rotator) -- [mod=rotator&updaterate=2000](https://etrusci.org/tool/olay/?mod=rotator&updaterate=2000) -- [mod=rotator&updaterate=2000&items=|one|two|three](https://etrusci.org/tool/olay/?mod=rotator&updaterate=2000&items=|one|two|three) -- [mod=rotator&updaterate=2000&items=|one|two|three&shuffle=false](https://etrusci.org/tool/olay/?mod=rotator&updaterate=2000&items=|one|two|three&shuffle=false) - ----