{"id":13830126,"url":"https://github.com/MichMich/MMM-Snow","last_synced_at":"2025-07-09T11:32:07.294Z","repository":{"id":147816948,"uuid":"77041853","full_name":"MichMich/MMM-Snow","owner":"MichMich","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-20T23:20:03.000Z","size":195,"stargazers_count":59,"open_issues_count":5,"forks_count":16,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-04T02:51:09.564Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MichMich.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-12-21T10:28:03.000Z","updated_at":"2025-03-11T04:44:26.000Z","dependencies_parsed_at":"2023-06-02T12:45:54.680Z","dependency_job_id":null,"html_url":"https://github.com/MichMich/MMM-Snow","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MichMich/MMM-Snow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichMich%2FMMM-Snow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichMich%2FMMM-Snow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichMich%2FMMM-Snow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichMich%2FMMM-Snow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichMich","download_url":"https://codeload.github.com/MichMich/MMM-Snow/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichMich%2FMMM-Snow/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264450546,"owners_count":23610191,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T10:00:56.062Z","updated_at":"2025-07-09T11:32:07.006Z","avatar_url":"https://github.com/MichMich.png","language":"JavaScript","funding_links":[],"categories":["Entertainment"],"sub_categories":[],"readme":"# Module: MMM-Snow\nInspired by [NHubbard's Snow Plugin](https://github.com/nhubbard/MagicPlugins/tree/master/snow) I created a little more realistic snow plugin to improve your winter experience! \n\nThe module supports themes. Current themes are *winter* and *love*. The first one let's it snow while the latter conjurs hearts on your mirror.  \n\n**Screenshot theme \"winter\"**\n\n![](.github/example-winter.png)\n\n**Screenshot theme \"love\"**\n\n![](.github/example-love.png)\n\n**Screenshot theme \"water\"**\n\n![](.github/example-water.png)\n\n## Installation\n\nIn your terminal, go to your MagicMirror's Module folder:\n````\ncd ~/MagicMirror/modules\n````\n\nClone this repository:\n````\ngit clone https://github.com/MichMich/MMM-Snow.git\n````\n\nConfigure the module in your `config.js` file.\n\n**Note:** After starting the Mirror, it will take a few seconds before the snow begins to fall ...\n\n## Using the module\n\nTo use this module, add it to the modules array in the `config/config.js` file:\n````javascript\nmodules: [\n\t{\n\t\tmodule: 'MMM-Snow',\n\t\tposition: 'fullscreen_above',\n\t\tconfig: { // See 'Configuration options' for more information.\n\t\t\tflakeCount: 100,\n\t\t\ttheme: \"winter\"\t\t\t\n\t\t}\n\t}\n]\n````\n\n## Configuration options\n\nThe following property can be configured:\n\n\n|Option|Description|\n|---|---|\n|`flakeCount`|The number of snow flakes. More flakes are havier for the cpu, so don't go wild. \u003cbr\u003e**Default value:** `100`|\n|`theme`| Defines the type of \"flakes\". Possible values are `winter`, `love`, and `water`.\u003cbr\u003e**Default value:** `winter`|\n\n## Defineing new themes\n\nCertainly, there are many opportunities for new themes. To extend this module with new themes takes three simple development steps.\n\n### Add image files\nAdd your \"flake\" images to folder `./images` in `MMM-Snow`directory. The image has to be a PNG with transparent background color. Make size of the file similar to existing files (50x50). The file names have to have a prefix followed by a number, e.g. `foo1.png`, `foo2.png`, `foo3.png`.\n\n### Reference images in CSS classes\nCreate new CSS classes in `MMM-Snow.css`, which reference your images. Class name and file name n´have to be identical. \n````css\n.MMM-Snow .foo1 {background-image: url('images/foo1.png');}\n.MMM-Snow .foo2 {background-image: url('images/foo2.png');}\n````\n\n### Define theme\nExtend the `themes` map in the file `MMM-Snow.js`. Just add another entry   \n````javascript\n\"bar\"   : { \n\t\"flakePrefix\" : \"foo\",    \n\t\"imagesCount\"  : 3,         // number of images in this theme, here:  foo1, foo2, foo3\n\t\"downwards\"    : false,     // flakes move upwards from bottom to top\n\t\"sizeFactor\"   : 2}         // adapt size of flakes to your liking, \u003c1 smaller, =1 original, \u003e1 larger \n````\nThe named index `bar` is the externally visible theme name, which has to be used in `config.js`. Setting `flakePrefix` tells how the image files and CSS classes are called; in our example it should be `foo`. `imagesCount` defines how many image files / css classes are there. If you have three images, put `3` which makes the module using `foo1`, `foo2`, and `foo3` respectively. The boolean setting `downwards` defines the direction of flakes' movements; `true` means downwards and `true` means upwards. Setting `sizeFactor` makes the flake images larger or smaller; values between 0 and 1 makes the flake smaller, while values larger  than 1 enlarges them.\n\n### Configure new theme\nTo use the new theme, change the `theme` parameter for the `MMM-Snow` module in the `config/config.js` file:\n````javascript\nmodules: [\n\t{\n\t\tmodule: 'MMM-Snow',\n\t\tposition: 'fullscreen_above',\n\t\tconfig: {\n\t\t\ttheme: \"bar\"\n\t\t}\n\t}\n]\n````\nAfter restarting the mirror the new MMM-Snow theme should be displayed. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMichMich%2FMMM-Snow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMichMich%2FMMM-Snow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMichMich%2FMMM-Snow/lists"}