Skip to content

A Magic Mirror module that displays a daily bit of Buddhist wisdom from Thich Nhat Hanh's "Your True Home".

License

Notifications You must be signed in to change notification settings

anthpham/MMM-DailyBuddhismWisdom

Repository files navigation

MMM-DailyBuddhismWisdom

A module for the Magic Mirror project by Michael Teeuw that displays a daily bit of Buddhist wisdom from Thich Nhat Hanh's Your True Home based on the current day of the year.

Screenshot

Screenshot on August 25th 2020, the 238th day of the year with default config. Screenshot on August 25th 2020, the 238th day of the year with example config.
Screenshot on August 25th 2020, the 238th day of the year with default config. Screenshot on August 25th 2020, the 238th day of the year with example config.

Preconditions

  • MagicMirror2 instance
  • Node.js version >= 7
  • npm

Installing

In your MagicMirror directory:

cd modules
git clone https://github.com/anthpham/MMM-DailyBuddhismWisdom.git
cd MMM-DailyBuddhismWisdom
npm install

Updating

Go to the module’s folder inside MagicMirror modules folder and pull the latest version from GitHub and install:

git pull
npm install

Configuring

There is not very much to configure but here are the options:

Option Description
show_page

A boolean value that determines whether this module's text should be displayed or not.

Type: boolean OPTIONAL
Example: false
Default Value: true

font_size

A string that determines the size of the font.

Type: string OPTIONAL
Example: "medium"
Default Value: "small"
Options: "xx-small" "x-small" "small" "medium" "large" "x-large" "xx-large"

font_weight

A string that determines the weight of the font.

Type: string OPTIONAL
Example: "lighter"
Default Value: "bold"
OPTIONS: "lighter" "normal" "bold" "bolder"
Light to bold: "100" "200" "300" "400" (normal) "500" "600" "700" (bold) "800" "900"

text_align

A string that determines the alignment of the text.

Type: string OPTIONAL
Example: "center"
Default Value: "left"
OPTIONS: "left" "right" "center" "justify"

line_height

A string that determines the distance between lines in the text.

Type: string OPTIONAL
Example: "normal"
Default Value: "1"
OPTIONS: "normal"
"*number*" A number that will be multiplied with the current font size to set the line height

show_author_book

A boolean value that determines whether the author and book's title shoudl be displayed at the end of the quote.

Type: boolean OPTIONAL
Example: false
Default Value: true

Here is an example for an entry in config.js

{
    module: "MMM-DailyBuddhismWisdom",
    position: "top_bar",

    config: {
        font_size: "medium",
        font_weight: "500",
        text_align: "center",
        show_author_book: false
    }
}

Special Thanks

  • Michael Teeuw for inspiring me and many others to build a MagicMirror module.
  • Sam Detweiler for finding and fixing errors in this module.

Contributing

If you find any problems, questions, or suggestions, please open a GitHub issue in this repository.

About

A Magic Mirror module that displays a daily bit of Buddhist wisdom from Thich Nhat Hanh's "Your True Home".

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published