Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/delightedCrow/MMM-HabiticaStats
MMM-HabiticaStats is a module for MagicMirror² that displays player statistics for Habitica.
https://github.com/delightedCrow/MMM-HabiticaStats
habitica habitica-account magicmirror
Last synced: 3 months ago
JSON representation
MMM-HabiticaStats is a module for MagicMirror² that displays player statistics for Habitica.
- Host: GitHub
- URL: https://github.com/delightedCrow/MMM-HabiticaStats
- Owner: delightedCrow
- License: mit
- Created: 2019-10-12T18:20:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-07T02:41:46.000Z (over 4 years ago)
- Last Synced: 2024-06-29T09:35:14.812Z (5 months ago)
- Topics: habitica, habitica-account, magicmirror
- Language: CSS
- Homepage:
- Size: 11.4 MB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-HabiticaStats**
README
# MMM-HabiticaStats: A MagicMirror² Module
`MMM-HabiticaStats` is a module for [MagicMirror²](https://github.com/MichMich/MagicMirror) that displays player statistics for [Habitica](https://habitica.com).
**REQUIRED API KEYS:**
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).
## Screenshots
### Example Screenshots of MMM-HabiticaStats running in the default MagicMirror² theme:
-------
### Example Screenshots of MMM-HabiticaStats running in the [WallberryTheme](https://github.com/delightedCrow/WallberryTheme):
## Installing the Module
To use this module:
1. Copy the `MMM-HabiticaStats` folder to your `MagicMirror/modules` directory
2. Add the module to the modules array in the `config/config.js` file like in the following example:
````javascript
modules: [
{
module: "MMM-HabiticaStats",
position: "middle_center", // put it wherever you want
config: {
userID: "YOUR-HABITICA-USER-ID-HERE",
APIToken: "YOUR-HABITICA-API-TOKEN-HERE"
}
}
]
````
## Configuration options
The following properties can be configured:
| Option | Type | Description
| ----------------------------|---------| -----------
| `userID` | String | Your Habitica userID. Sign up for free at [https://habitica.com](https://habitica.com).
This value is **REQUIRED**
| `APIToken` | String | Your Habitica API Token.
This value is **REQUIRED**
| `refreshRate` | Number | How often the module should refresh your Habitica data (in milliseconds).
**Possible values:** Any positive integer
**Default value:** `60 * 60 * 1000`, 1 hour
| `backgroundBlurOn` | Boolean | Turn the background blur on; good for making the text more legible on photo backgrounds.
**Possible values:** `true` (turn on) or `false` (turn off)
**Default value:** `true`
| `zoom` | Float | Scale this module using the CSS zoom property.
**Possible values:** A float number. Examples: `1.5` (scale up 150%), `0.7` (scale down 70%)
**Default value:** none
| `orientation` | String | Whether to display the module in portrait or landscape orientation.
**Possible values:** `portrait`, `landscape`
**Default value:** `portrait`
| `positionCSS` | String | Finely position this module with the power of CSS. BE CAREFUL, you can break all kinds of things with this.
**Possible values:** Any string of valid CSS. Example: `"float: right; position: relative; top: -10px;"`
**Default value:** none
## Fixing The Background Blur
##### Please make sure you have the config option `backgroundBlurOn: true` set first!
If 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:
````javascript
electronOptions: {
webPreferences: {
experimentalFeatures: true,
nodeIntegration: false
}
},
````
## Contributing & Development
### Changelog
To view the changelog see [CHANGELOG.md](CHANGELOG.md).
### Building CSS
This module uses SASS, so to make style changes please edit the `MMM-HabiticaStats.scss` file and use node-sass to compile the css file:
- Run the command `npm install` to install node-sass.
- Run `npm run watch` and node-sass will autocompile the CSS file any time changes are made to the `MMM-HabiticaStats.scss` file.
- Run `npm run build` to build the CSS file.