{"id":13830369,"url":"https://github.com/delightedCrow/MMM-HabiticaStats","last_synced_at":"2025-07-09T11:32:49.018Z","repository":{"id":79631004,"uuid":"214694518","full_name":"delightedCrow/MMM-HabiticaStats","owner":"delightedCrow","description":"MMM-HabiticaStats is a module for MagicMirror² that displays player statistics for Habitica.","archived":false,"fork":false,"pushed_at":"2020-04-07T02:41:46.000Z","size":11960,"stargazers_count":18,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-04T10:02:59.117Z","etag":null,"topics":["habitica","habitica-account","magicmirror"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/delightedCrow.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-12T18:20:06.000Z","updated_at":"2024-01-10T21:00:58.000Z","dependencies_parsed_at":"2024-01-15T17:39:05.590Z","dependency_job_id":"d4742533-ea29-4998-9f3c-10fbde17461c","html_url":"https://github.com/delightedCrow/MMM-HabiticaStats","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delightedCrow%2FMMM-HabiticaStats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delightedCrow%2FMMM-HabiticaStats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delightedCrow%2FMMM-HabiticaStats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delightedCrow%2FMMM-HabiticaStats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/delightedCrow","download_url":"https://codeload.github.com/delightedCrow/MMM-HabiticaStats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225539382,"owners_count":17485316,"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":["habitica","habitica-account","magicmirror"],"created_at":"2024-08-04T10:00:59.148Z","updated_at":"2024-11-20T11:30:42.499Z","avatar_url":"https://github.com/delightedCrow.png","language":"CSS","funding_links":[],"categories":["Productivity"],"sub_categories":[],"readme":"# MMM-HabiticaStats: A MagicMirror² Module\n`MMM-HabiticaStats` is a module for [MagicMirror²](https://github.com/MichMich/MagicMirror) that displays player statistics for [Habitica](https://habitica.com).\n\n **REQUIRED API KEYS:**\n\n You're gonna need a (free) Habitica account to get an API token (see the [Habitica wiki](https://habitica.fandom.com/wiki/API_Options#API_Token) for details on how to find your API Token in your Habitica account).\n\n## Screenshots\n\n### Example Screenshots of MMM-HabiticaStats running in the default MagicMirror² theme:\n\n\u003cimg width=\"400\" src=\"screenshots/MM_portrait_DefaultTheme.png\"\u003e\n\n-------\n\n\u003cimg width=\"600\" src=\"screenshots/MM_landscape_DefaultTheme.png\"\u003e\n\n\n### Example Screenshots of MMM-HabiticaStats running in the [WallberryTheme](https://github.com/delightedCrow/WallberryTheme):\n\n\u003cimg width=\"600\" src=\"screenshots/WB_landscape_fullscreen.jpg\"\u003e\n\n## Installing the Module\n\nTo use this module:\n1.  Copy the `MMM-HabiticaStats` folder to your `MagicMirror/modules` directory\n2.  Add the module to the modules array in the `config/config.js` file like in the following example:\n\n````javascript\nmodules: [\n\t{\n\t\tmodule: \"MMM-HabiticaStats\",\n\t\tposition: \"middle_center\", // put it wherever you want\n\t\tconfig: {\n\t\t\tuserID: \"YOUR-HABITICA-USER-ID-HERE\",\n\t\t\tAPIToken: \"YOUR-HABITICA-API-TOKEN-HERE\"\n\t\t}\n\t}\n]\n````\n\n## Configuration options\n\nThe following properties can be configured:\n\n\n| Option                      | Type    | Description\n| ----------------------------|---------| -----------\n| `userID`                    | String  | Your Habitica userID. Sign up for free at [https://habitica.com](https://habitica.com). \u003cbr\u003e\u003cbr\u003e  This value is **REQUIRED**\n| `APIToken`                  | String  | Your Habitica API Token. \u003cbr\u003e\u003cbr\u003e  This value is **REQUIRED**\n| `refreshRate`               | Number  | How often the module should refresh your Habitica data (in milliseconds). \u003cbr\u003e\u003cbr\u003e **Possible values:** Any positive integer \u003cbr\u003e **Default value:** `60 * 60 * 1000`, 1 hour\n| `backgroundBlurOn`          | Boolean | Turn the background blur on; good for making the text more legible on photo backgrounds. \u003cbr\u003e\u003cbr\u003e **Possible values:** `true` (turn on) or `false` (turn off) \u003cbr\u003e **Default value:** `true`\n| `zoom`                      | Float   | Scale this module using the CSS zoom property. \u003cbr\u003e\u003cbr\u003e **Possible values:** A float number. Examples: `1.5` (scale up 150%), `0.7` (scale down 70%) \u003cbr\u003e **Default value:** none\n| `orientation`               | String  | Whether to display the module in portrait or landscape orientation. \u003cbr\u003e\u003cbr\u003e **Possible values:** `portrait`, `landscape`\u003cbr\u003e **Default value:** `portrait`\n| `positionCSS`               | String  | Finely position this module with the power of CSS. BE CAREFUL, you can break all kinds of things with this. \u003cbr\u003e\u003cbr\u003e **Possible values:** Any string of valid CSS. Example: `\"float: right; position: relative; top: -10px;\"` \u003cbr\u003e **Default value:** none\n\n## Fixing The Background Blur\n\n##### Please make sure you have the config option `backgroundBlurOn: true` set first!\n\nIf you're running MagicMirror using Electron (i.e, not in `serveronly` mode) and the background blur isn't showing up for you, try enabling Electron's `experimentalFeatures` option by adding the following block to your `config` options in your MagicMirror `config.js` file:\n\n````javascript\nelectronOptions: {\n\twebPreferences: {\n\t\texperimentalFeatures: true,\n\t\tnodeIntegration: false\n\t}\n},\n````\n\n## Contributing \u0026 Development\n\n### Changelog\n\nTo view the changelog see [CHANGELOG.md](CHANGELOG.md).\n\n### Building CSS\n\nThis module uses SASS, so to make style changes please edit the `MMM-HabiticaStats.scss` file and use node-sass to compile the css file:\n\n- Run the command `npm install` to install node-sass.\n- Run `npm run watch` and node-sass will autocompile the CSS file any time changes are made to the `MMM-HabiticaStats.scss` file.\n- Run `npm run build` to build the CSS file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FdelightedCrow%2FMMM-HabiticaStats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FdelightedCrow%2FMMM-HabiticaStats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FdelightedCrow%2FMMM-HabiticaStats/lists"}