SteamGifts v2 Giveaway Filter (with SteamGifts++ and SGv2 Dark support)

SteamGifts v2 Giveaway Filter (with SteamGifts++ and SGv2 Dark support)

Back in the days of (good) old SteamGifts v1, I couldn't even image using the site without SteamGifts+ with endless scrolling and giveaway filtering. When SteamGifts v2 was in beta, I heard about people working on SteamGifts++, a version of SteamGifts+ for the new site. I was pretty happy thinking that when the new site comes out, I'll be able to use it the same way as before. Unfortunatelly, development of SG++ stopped, probably due to personal/time reasons which I completely understand and respect. One feature in the current SG++ was missing though, and it was the giveaway filtering, a crucial part of the original SG+ plugin. I waited a few months and after I did my first "Hello world" in Javascript, I decided I'd try to create the filtering scrip for myself. After I did, I sent it to the proud people of The Reset and surprisingly they liked it (thanks for the alpha testing, guys). Even though I refused it before, I decided to try to make a UI for the filter and make it public. And here we are!

You might ask why I didn't add the filtering to SG++ itself. I looked at it and they seemed to use some framework(s) which I didn't want to learn since pure Javascript seemed enough for the job. If anyone wants and is skilled enough, he/she can take this plugin and convert it to SG++, I won't mind. Just be aware that if you do so, I won't be able to support the development of the plugin as much as I could if it'd have stayed in pure Javascript. Now as mentioned earlier, I'm no web/Javascript developer and I don't aspire to be one. If you look at the code and think it's ugly, wrong or anything like that, I'll be happy to take any suggestions you can give me to improve it. Just try to avoid comments like "use jQuery, you noob" since these are not helping at all. If you want and think you can, you can always create a pull request and I'll be happy to take a look at your work and merge it into the plugin if possible.

I'll try to monitor the discussion below and try to implement the most requested features into the plugin, but since I'm working on the plugin in my free time, I might refuse to implement some features if I think it's too hard to do them properly without significant usability gain or I might take "forever" to develop them if I just don't have time to do it at the moment.

Thanks for reading, I hope you enjoy the plugin and happy giving/winning!

Features

• Filtering giveaways based on the level required to join, number of entries and/or points required to enter.
• Possibility to exclude group/whitelist/pinned/region-restricted giveaways from filtering.
• Filtering enabled on per-page basis.
• Hide entered giveaways (with or without respect to other filter options).
• Support for SG++ endless scroll and grid view.
• Remove pagination for truly seamless endless scrolling.

Screenshot here

Requirements

• Firefox 38+ with Greasemonkey 3+
• Chrome 43+ with Tampermonkey 3.10+
• Opera 29+ with Tampermonkey 3.10+

It might work with older versions of the browsers or userscript plugins, but it has been tested on those above mentioned. If it works on older versions, share it in the comments and I'll try to update the requirements based on what you say. My intention is to always make it work on the newest version of the browser/plugin without any backwards compatibility unless explicitly requested.

Download

There are three options how to get the plugin:

• The release version - download here - suitable for most, should always be stable and without any major bugs.
• The beta version - download here - suitable for those that want new features/bugfixes early and don't mind some minor problems with the plugin.
• The development version - download here - for enthusiasts, always have the current state-of-the-art technology, but might contain plugin-breaking bugs.

Changelog

0.5.7-BETA

• Fixed filtering on the main page in Chrome.

0.5.6-BETA

• Added support for the "Recommended" giveaway view.

0.5.5-BETA

• Fixed filtering not working after SG moved to the HTTPS protocol. - by SilentGuy
• Fixed SG++ GridView filtering not working properly. - by SilentGuy/SquishedPotatoe

0.5.4-BETA

• Added support for SGv2 Dark. (REQ2) - by SquishedPotatoe
• Fixed filter being displayed in the details of a giveaway. - by 0657code
• Fixed filtering not working in some versions of Chrome (hopefully should be working now).

0.4.2-BETA

• Changed the hide entered giveaways option to have multiple modes ("Yes" and "Always") with different behavior.

0.4.1-BETA

• Added an option to filter giveaways based on points required to enter. (REQ3)
• Added an option to exclude region-restricted giveaways from filtering.
• Added an option to hide entered giveaways.
• Added an option to remove pagination (for truly seamless endless scrolling). (REQ1) - by Timmaeh
• Fixed filtering not working when there are no pinned giveaways.
• Fixed giveaways user can't currently enter due to level requirements being filtered as well even when they belong to the level range.

0.2.2-BETA

• Fixed support for SG++ 0.4.0beta.

0.2.1-BETA

• Fixed handling of pinned GAs in the SG++ grid view.

0.2-BETA

• Initial version of the script.

Requested features

• SG++ gridview with no spacing (REQ1 by tragikos) (+1 by Snake994) - DONE by Timmaeh
• SGv2 Dark support - the UI currently does not recolor (REQ2 by SilentGuy) (+1 by bmh67wa) - DONE by SquishedPotatoe
• Filtering by points required to enter (REQ3 by Snake994) - DONE
• Exclude option for Wishlist games (REQ4 by SweetDalilah)
• Filtering by chance to win (REQ5 by Toff) (+2 by zombiehug, lochive)
• Show entered GAs not meeting the filtering criteria (REQ6 by zombiehug)
• Show region-restricted GAs only, possibly a new item in the left menu (REQ7 by vigilium)
• Show Steam review stats for every GA, possibly in a new script (REQ8 by kazerniel)
• Filtering by amount of copies being given away (REQ9 by FeiLing) (+2 by SErVER51, dragon290513)

I'll try to keep track of the features requested by you here. You can "like" a request by positively mentioning it in your comment with the REQ code assigned to all requests. I'll try to keep track of the likes and requests with more likes will get more attention.

Contributors

(in order in which they did their first commit)

• Timmaeh
• 0657code
• SquishedPotatoe
• SilentGuy

Supporting the plugin

If you can and want, the best support is to go and code a requested feature and send a pull request with it. You'll be listed as a contributor/developer of course. If you can't or don't want to be involved in the development, there is another way how to support. Now before I tell you more, let me say that I'll continue the development unless stated otherwise without any further support, but supporting might increase the speed of the development or push forward some features you'd like to see, but everything is strictly voluntary. If you want, you can support by donating me a game from my wishlist. While donating, we can talk about what feature or anything else you'd like to see in the plugin and we can agree that I'll do it based on your donation. If we, for some reason, don't agree, you don't have to donate the game, it's completely voluntary. You can also donate games not on my wishlist, but always consult me before because I don't want to just hoard games I'm not going to play. You'd do better service just simply giving the game away on SteamGifts instead of giving it to me :). I don't accept any money or any other kind of stuff/services.