Coder Social home page Coder Social logo

pbojan / cryptocoins-desklet-windows Goto Github PK

View Code? Open in Web Editor NEW
33.0 9.0 7.0 6.19 MB

Windows Desklet/Widget/Gadget that displays the current price of more than 1500+ coins and their daily percent changes.

License: MIT License

Lua 100.00%
windows gadget widget windows-gadget windows-widget cryptocurrency crypto cryptocoins bitcoin ticker

cryptocoins-desklet-windows's Introduction

Crypto Coins Skin/Desklet for Windows

Windows Desklet, Widget, Gadget, Rainmeter Skin that displays the current price of more than 1500+ coins and their daily percent changes.

Desklet screenshot

Usage Help

Requirements

To be able to use this Desklet first you will need to have the necessary requirements:

NOTE: Rainmeter is a completely safe, free and open-source application for Windows PCs. It is a platform that enables skins to run on your desktop. For more information check out: https://docs.rainmeter.net/manual/getting-started/

Installation

To use the Desklet first you need to install it, steps are below:

  1. Download the latest release version file .rmskin from https://github.com/pbojan/cryptocoins-desklet-windows/releases
  2. Double-click the .rmskin file and then click Install.

NOTE: For more about installing skins check out: https://docs.rainmeter.net/manual/installing-skins/

Usage

To add the Desklet to your desktop, please follow the steps below:

  1. Make sure you have Rainmeter running
  2. Right-click on the Rainmeter icon in the tray and select Manage
  3. Find the file pbojan -> CryptoCoins -> Bitcoin -> Bitcoin.ini
  4. Select it and click Load in the top-right corner and this will load the desklet on your desktop
  5. Right-click the Desklet and select Edit Skin
  6. Replace ApiKey=YOUR_API_KEY with your CoinMarketCap API key
  7. You can load multiple desklets by finding the .ini file and clicking Load. Repeat steps 5 & 6 to add your API key
  8. Now you can move the desklet to your desired location on the desktop!

NOTE: This Dekslet comes with few different crypto-coins configured out of the box but it is really easy to configure any crypto-coin available on http://coinmarketcap.com! Check out the next section to find out how.

Adding New Coin Desklet

To add new crypto-coin as a Desklet, please follow the steps below:

  1. Open the Rainmeter skins directory, usually C:\Users\#YourName#\Documents\Rainmeter\Skins\pbojan\CryptoCoins
  2. Copy the Bitcoin folder and name it the as crypto-coin you want to add e.g. Dash
  3. Go into the folder and rename the Bitcoin.ini file to Dash.ini, now you should have C:\Users\#YourName#\Documents\Rainmeter\Skins\pbojan\CryptoCoins\Dash\Dash.ini
  4. Open the file with any editor and change:
    • Change the ApiKey to the API key you got from your CoinMarketCap account
    • Change the CoinSymbol to the Symbol of the crypto-coin you want to add e.g. CoinSymbol=DASH (make sure it is in upper case)
      • In some rare cases where some currencies have the same symbol e.g. BTCV you can also use CoinID=5175 to specify exactly which currency to show.
      • You can find the CoinID by going on the tools section for your coin e.g. https://coinmarketcap.com/currencies/bitcoin-vault/tools/ and in the Website Widget section find the following field data-currencyid in this case data-currencyid="5175"
    • Change the Currency to the desired Currency you want to see the price as e.g. Currency=USD (make sure it is in upper case). You can find all supported currencies on this page: https://coinmarketcap.com/api/documentation/v1/#section/Standards-and-Conventions
  5. Save the changes, now you can add your coin desklet from the Manage window, check the Usage section for more details

NOTE: This Dekslet comes with more than 470+ crypto-coins icons out of the box but in the case when the coin icon is not displayed for your coin that means you need to add the icon:

  • Download an icon for you crypto-coin and move it to C:\Users\#YourName#\Documents\Rainmeter\Skins\pbojan\@Resources\icons\
  • Make sure the icon is named the same as the CoinSymbol e.g. dash.png
  • For best results make sure the icon has the same aspect ration for width/height and is at least 50x50 pixels big

Troubleshooting

If your desklet is not working follow the next steps to find out why:

  1. Check if you have added your API-KEY to the desklet config:
    • Right-click the Desklet and select Edit Skin to open the configuration.
  2. Check the rainmeter logs:
    • Right-click the Desklet select Manage Skin and click Open Log on the bottom left.
  3. Check the coinmarketcap account logs:

Bugs/Feedback

If you find any bugs or stability issues please create an issue here or send an email to [email protected].

If you have ideas for new features or improvements please send an email to [email protected].

Contribute/Donate

If you want to support the work and maintenance of this Desklet, please consider donating. Every donation is highly appreciated!

BTC: bc1q82zg96fgeenr5ag254lnqt4nn77lzjf5nx9m00
BCH: qq57wcmp7ajgpzgxhme5ldfwwfmkja8qd5mmaf6rlz
LTC: ltc1q362me09lmxfcq6zex6968qsnnq6hz3nhxv4cyr
ETH: 0x1125207ae7d169eb623fa228e5b2c48a6b6482d9

Can't donate but you still want to help? Here are a few ways how to support this project:

  • Give feedback, report any bug or issue you find
  • Improve the Desklet by creating a pull request to add new features. If you want to add new features please first send an email to [email protected] and describe your idea.
  • Star/Watch the project on Github
  • Spread the word and share this desklet with your friends, colleagues, social networks, etc.

Credits

  1. The Desklet currently is using the PRO API from https://pro.coinmarketcap.com/
  2. The icons are from https://github.com/cjdowner/cryptocurrency-icons

MIT License

Copyright (c) 2018-2022 Bojan Petkovski

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

cryptocoins-desklet-windows's People

Contributors

pbojan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cryptocoins-desklet-windows's Issues

not work API

Hallo / Привет
The api code does not work for me for 2 days, there are errors: (Fetch error) Unable to communicate with the server (ErrorCode = 12029)

update version, the problem is not solved
Rainmeter v4.5.2
CryptoCoins v1.6
Thanks
Снимок

RegExp matching error

All skins stopped working. The log file shows the RegExp error:

NOTE (21:25:41.794) pbojan\CryptoCoins\Bitcoin\Bitcoin.ini: Refreshing skin
NOTE (21:25:41.875) pbojan\CryptoCoins\Cardano\Cardano.ini: Refreshing skin
ERRO (21:25:41.892) pbojan\CryptoCoins\Bitcoin\Bitcoin.ini - [MeasureCoinData]: RegExp matching error (-1)
NOTE (21:25:41.951) pbojan\CryptoCoins\Etherium\Ethereum.ini: Refreshing skin
ERRO (21:25:41.972) pbojan\CryptoCoins\Cardano\Cardano.ini - [MeasureCoinData]: RegExp matching error (-1)
ERRO (21:25:42.030) pbojan\CryptoCoins\Etherium\Ethereum.ini - [MeasureCoinData]: RegExp matching error (-1)

25 Minutes delay

Is there any way to increase the refresh rate of the updates on prices?

Issue Displaying Data on Linux Mint When Initial GET is Interrupted

Hi,

I am running your desklet on Linux Mint 21 (Cinnamon Version 5.4.12).

I noticed when I use a VPN (Torguard) at system startup, the delay in setting up the VPN causes the initial GET requests to fail. This leaves a desklet displaying, "Loading coin data..". So was assuming once that polling timer elapses another GET request will go out. I set the refresh timer to the minimum of 5 minutes.

What I noticed was that on that when logged into the coinmarketcap API page, that the subsequent requests are seen (every 5 minutes) and they are deemed successful.

But the desklet itself does not display the data. In order to display the data, I need to configure the disklet, cut the API key, so the "Missing API" message shows up, then paste it back in at which point the desklet works normally.

Obviously the initial request failing is not an app issue. But it is strange the subsequent requests fail as well.

So I repeated the whole test, by disabling my NIC and wireless (so no VPN this time). Once loaded into the environment (desklets have failed as expected). In this case, the same thing happened. Sorry I was testing this as I typed the above, so I guess the VPN bit doesn't apply.

It appears if the initial request is not serviced, the subsequent requests even though registered at the far end, do not induce the correct content to display.

Thanks

Calculating/Display errors with tokens/coins that have a very low value

If you add SAFEMOON to the coins/tokes you want to track, it displays the values not with the leading 5 zeros,
but like 4e-06, also if i add a calculation to the widget of my actual amount of tokens, the sum is wrong.

Here my way to display the actual amount of my coins/tokens:

`[MeasurePrice]
Measure=Calc
Formula=(0.11556 * MeasureCoinPriceRounded)
DynamicVariables=1

[MeterDisplayOverallPrice]
Meter=String
MeasureName=MeasurePrice
MeterStyle=StyleFont | StylePrice
X=100
Y=90
Text= %1 #Currency#`

Another token that is displayed completely wrong is BONFIRE, which now sits at 0.000000x.
The actual price is shown as "0", and of course the calculation then displays "0".

My theory is, that the problem lies in the way the value is called in "Cryptocoins.ini", and then leads to the display/calculation error. But my knowledge of that all is not good enough to fix this issue by myself.

Greetings and thanks for the good work!

Catecoin

ive been using this widget as my go to crypto ticker, but it seems like i am having problem when i put catecoin to a custom skin, at first it shows the cash tech coin but when i started to use the catecoin data currency id the widget does not show info about the crypto

Time on widget 1 hour out

Have just setup v1.4 and have got it working correctly with the coins I want to monitor, however the date/time at the bottom of each widget is 1 hour slow.
Have tried changing the localtime and utctime settings in the script but have been unsuccessful. Would you have any advice on adding time +1 hour?

Feature Request: Refresh option

I would like to suggest a refresh option from the menu on the desklet. Sometimes the tracker gets stuck, and won't refresh until I leave my DE, or re-enter the api key.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.