PageRenderTime 54ms CodeModel.GetById 22ms RepoModel.GetById 1ms app.codeStats 0ms

/README.md

https://github.com/alanpoulain/Elementary
Markdown | 107 lines | 88 code | 19 blank | 0 comment | 0 complexity | 75db8d0d4af014aff088c835266ce43e MD5 | raw file
  1. ##Elementary
  2. Some simple, clean [Rainmeter](https://github.com/rainmeter/rainmeter) skins, including skins for
  3. - Time and Date
  4. - The Weather ([Yahoo!](http://weather.yahoo.com/))
  5. - Notes
  6. - Your media player ([NowPlaying](http://docs.rainmeter.net/manual/plugins/nowplaying))
  7. - Basic system monitoring
  8. (cpu, ram, hard drive space, NIC traffic, and uptime)
  9. - RSS and ATOM feeds (modded [YQLFeed][jsm-yqlfeed])
  10. - File and Web search ([Locate32](http://locate32.cogit.net/) and [DuckDuckGo](https://duckduckgo.com/about))
  11. Rainmeter _3.0.2_ or later is required for these skins to function properly. You can get the latest version from [Rainmeter.net](http://rainmeter.net/).
  12. The RMSKIN installer package for these skins can be downloaded from [DeviantArt][devart] or [GitHub](https://github.com/FlyingHyrax/Elementary/releases).
  13. ### License
  14. This work is licensed under the [Creative Commons Attribution Non-Commercial Share-Alike 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/)
  15. In short, feel free to modify and redistribute these skins to your heart's content - just refer back to me, use the same license, and don't sell the work.
  16. ### Customization - Settings.txt
  17. Elementary's user preferences are in the file `...\Skins\Elementary\@Resources\Settings.txt`. Open this file in any plaintext editor to change settings. You can also right-click on an Elementary skin, and in the context menu select `Elementary` > `Settings.ini` to quickly open the file in Windows Notepad.
  18. Settings are given in `Key=Value` pairs; to change a setting, modify the portion after the `=` sign, save the file, and refresh any open Elementary skins.
  19. | Key | Description | Default |
  20. |----:|:------------|:-------:|
  21. | **font** | The primary font used by the skins. You can use any installed font, just keep in mind that the positions of the skin elements are optimized for the two default fonts. ([More information on Fonts in Rainmeter][fontdoc]) ([JSMorley's handy RainFont utility][rainfont]) | `Century Gothic`
  22. | **font2** | The secondary font used by the skins. See above. | `Futurist Fixed-Width`
  23. | **style** | Sets the attributes of the text in the skins. Valid values are `NORMAL`, `BOLD`, `ITALIC`, and `BOLDITALIC`. | `NORMAL`
  24. | **color** | The primary color for the skins, given in Decimal (`rrr,ggg,bbb,aaa`) or Hexadecimal (`RrGgBbAa`) format. For darker skins, try `0,0,0,200` and experiment from there. ([More information on Color Codes in Rainmeter][colordoc]) | `255,255,255,180`
  25. | **highlight** | An optional highlight color. By default, this is 'turned off' by setting it to `#color#`, so that the highlight color will match the main color. Simply change this to a valid color code to enable the highlight color. | `#color#`
  26. | **woeid** | The Yahoo! WOEID location code for the weather skin. You can lookup your WOEID [here][rosswoeid]. | `44418` (London)
  27. | **unit** | Changes the units used in the Weather skin. Use `f` for English and `c` for Metric. | `f`
  28. | **language** | The two letter [ISO 639-1 code][iso639] for your preferred language. Available language files can be viewed in `...\Elementary\@Resources\Languages\`. Current options are `en`, `ru`, and `de`. | `en`
  29. | **drive** | The letter of the hard drive to monitor with the system skin | `C:`
  30. | **player** | Music player for the NowPlaying skin. You can view a list of supported players and their respective `PlayerName` values in the [documentation for the NowPlaying plugin][nowplayingdoc]. | `CAD`
  31. | **hour** | The format code for the hour in the Time skins. For a 12-hour clock, use `%#I`; for a 24-hour clock, use `%#H`. To add leading zeros, remove the `#` sign (i.e., `%I` will give you '08' instead of '8'). | `%#I`
  32. | **scalar** | Scales the size of the analog clock. A larger number will increase the size; a smaller number will decrease it. I recommend staying between 1.5 and 5.0. | `3.0`
  33. | **FeedURL1** - **FeedURL6** | The URLs for the 6 RSS/Atom feeds in the YQLFeed skins. | _(various)_
  34. | **FeedTitle1** - **FeedTitle6** | The title for each feed | _(various)_
  35. [fontdoc]: <http://docs.rainmeter.net/tips/fonts-guide> "Guide to fonts in Rainmeter"
  36. [rainfont]: <http://rainmeter.net/forum/viewtopic.php?f=18&t=6103> "RainFont helper utility"
  37. [colordoc]: <http://docs.rainmeter.net/manual/options#Color> "Color codes in the Rainmeter Manual"
  38. [rosswoeid]: <http://woeid.rosselliot.co.nz/lookup/> "Yahoo WOEID Lookup by Ross Elliot"
  39. [nowplayingdoc]: <http://docs.rainmeter.net/manual/plugins/nowplaying#playerlist> "NowPlaying.dll in the Rainmeter Manual - list of supported players"
  40. ### Adding Languages - template.txt
  41. To make your own translation file to use with Elementary, look in `...\Elementary\@Resources\Languages\` for the file `template.txt`. This file lists all the 'keys' for the skins with no 'values' (translations).
  42. To make a new translation file:
  43. 1. Make a copy of the template file, naming the new copy something appropriate for your language. (I suggest the [ISO 639-1 code][iso639], because it is simple, universal, and will fit with the "official" translations.)
  44. 2. Open your new copy and fill in all the values after the `=` signs with the appropriate word or phrase in your language. Save your changes.
  45. 3. In `Settings.txt`, set `language` to whatever you named your new translation file (without the .txt extension). Save Settings.txt and refresh any open Elementary skins. The skins should now use your new translations.
  46. Please check the translation files already included in the `...\Languages\` folder for examples.
  47. **Some notes:**
  48. - The default fonts might not support the special characters needed for some languages. In such cases you will need to change the font to one that includes the correct characters.
  49. - Translation files with special characters should be encoded with Unicode. You can read more specifics [here][unicode] (see the section "Using Unicode in Rainmeter" for how to save the file in a particular text editor).
  50. - If a word/phrase in your language is much longer than that word/phrase in English, then there may be some problems with text being cut-off in some of the skins. This should be easily solved with a minor positioning tweak in that skin's .ini file, but consider using shorter synonyms if possible to make it easier to redistribute your translation.
  51. **If you would like to have your translation added to the official Elementary package:**
  52. - Send a Pull Request on [GitHub][gh]. Feel free to [fork the Elementary repository][fork], add your translation file, and [send a pull request][pullreq] so I can merge your translation into the main repo. (This is the preferred method as it makes it much easier for me to keep track of the files and who did what.)
  53. - Email me (see the "Contact" section below). Just attach your new translation's .txt file, and be sure to indicate how you would like to be credited (real name or username, the URL for your web site or DeviantArt page, that sort of thing).
  54. [iso639]: <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes> "Wikipedia: List of ISO 639-1 codes"
  55. [unicode]: <http://docs.rainmeter.net/tips/unicode-in-rainmeter> "Unicode in Rainmeter"
  56. [gh]: <https://github.com/FlyingHyrax/Elementary> "Elementary on Github"
  57. [fork]: <https://help.github.com/articles/fork-a-repo> "How to fork a repo"
  58. [pullreq]: <https://help.github.com/articles/using-pull-requests> "How to use pull requests"
  59. ### Contributors
  60. - JSMorley: [YQLFeed][jsm-yqlfeed] and [SearchDrive][jsm-searchdrive]
  61. - sa3er: Notes skin is based on [Note Paper][notepaper]
  62. - smurfier: Fixed, optimized, and generally improved Lua code
  63. - amc242: Russian translation
  64. - mothergarage: German translation
  65. [jsm-yqlfeed]: <http://www.deviantart.com/art/YQLFeed-3-3-419596824>
  66. [jsm-searchdrive]: <http://rainmeter.net/forum/viewtopic.php?f=27&t=17181>
  67. [notepaper]: <http://www.deviantart.com/art/Note-Paper-1-1-392404729>
  68. ### Credits
  69. - The primary font is [Century Gothic][cg] by Monotype Imaging
  70. - The secondary font is [Futurist Fixed-Width][ffw] by WSI
  71. - The wallpaper which inspired these skins, and is used for the .rmskin banner image and other preview images is [Elementary by emats][ebe]
  72. - Weather data and feed normalization is provided by the [Yahoo! YQL API][yql]
  73. - This file was written using [StackEdit.io][stackedit]
  74. - [S. D. G.][sdg]
  75. [cg]: <https://en.wikipedia.org/wiki/Century_Gothic>
  76. [ffw]: <http://www.dafont.com/futurist-fixed.font>
  77. [ebe]: <http://interfacelift.com/wallpaper/details/1919/elementary.html>
  78. [yql]: <http://developer.yahoo.com/yql/>
  79. [stackedit]: <https://chrome.google.com/webstore/detail/stackedit/iiooodelglhkcpgbajoejffhijaclcdg>
  80. [sdg]: <http://en.wikipedia.org/wiki/Soli_Deo_gloria>
  81. ### Contact
  82. Feel free to contact me with questions or suggestions:
  83. - [On DeviantArt][devart]
  84. - [Rainmeter Forums][forums]
  85. - [Email me][email]
  86. [devart]: <http://flyinghyrax.deviantart.com/> "FlyingHyrax on DeviantArt"
  87. [forums]: <http://rainmeter.net/forum/> "Official Rainnmeter forums"
  88. [email]: <mailto:theflyinghyrax@gmail.com> "mailto:me"