Willy-JL / F95Checker

GNU General Public License v3.0
101 stars 16 forks source link

F95Checker

An update checker and library tool for (NSFW) games on the F95Zone platform.

Features:

Download: here

Compatibility:

Built with Python 3.10+ for Windows, Linux and MacOS.

Binaries are available for all 3 platforms, requiring no setup at all. If instead you want to run from source note that Python 3.10+ is required and you'll need to install the requirements with pip.

Installation:

* If you get a message saying that the application is damaged and should be moved to the trash you need to: close the popup, open a terminal, navigate to the location of the F95Checker.app, type in xattr -d com.apple.quarantine F95Checker.app and press enter; after this the method above to open the app should work fine.

Browser extension

The F95Checker browser addon allows you to easily add games to you desktop F95Checker library while browsing the forum in 3 ways:

Also, it allows you to quickly see what games you have added to your list (and which tab) with convenient icons on the forum.

The extension is available for both major browser families (Brave and Edge count as Chrome, LibreWolf counts as Firefox):

Alternatively, you can find a guided install in F95Checker sidebar, in Extension > Install.

Please note that this extension is solely to aid the usage of the desktop tool, you still need the desktop application installed and running.

FAQ:

About the speed™:

F95Zone does not yet have a proper API serving the information needed by this tool, so the only way to gather them is by requesting the full game threads like a normal browser would. However this is not practical because it consumes a lot of network and computing resources, takes way too long and puts unnecessary stress on the forum servers. This tool makes a compromise: it makes small chunked requests to a dedicated API to check for new version numbers, and when an update is found it then fetches the full thread and scans it for all the game details. This is what allows F95Checker to quickly check thousands of games in a matter of seconds. However this will not detect many other changes, like status and description, so the tool will run periodic full rechecks once a week. When a full recheck happens you will see the status text in the bottom right corner saying "Running x full rechecks".

Progress and plans tracker:

Upcoming features and fixes are tracked on the GitHub Project page.

You can pitch your feature requests and bug reports either in the GitHub issues or on the F95Zone thread.

Old versions:

Versions before 7.0 are archived in the F95Zone thread.

Disclaimer:

Due to the lack of a proper F95Zone API, this tool needs to grab the threads just like a browser would, and this entails requiring an account to read spoiler content. I know you might be skeptical about inserting your account credentials into some random dude's program, and I totally agree with you if you are, but you can read through the code and you will see that this doesn't do anything harmful. If you still aren't sure you can create a second account just for this program.

Contributing:

Please do! I poured my heart and soul into this tool and hearing suggestions or getting help with the code really helps!

You can help out in many ways, from simply suggesting features or reporting bugs (you can do those in the GitHub issues or on the F95Zone thread), to adding to the codebase (through GitHub pull requests or by posting patches in the F95Zone thread).

Developer note:

This software is licensed under the 3rd revision of the GNU General Public License (GPLv3) and is provided to you for free. Furthermore, due to its license, it is also free as in freedom: you are free to use, study, modify and share this software in whatever way you wish as long as you keep the same license.

However, F95Checker is actively developed by one person only, WillyJL, and not with the aim of profit but out of personal interest and benefit for the whole F95Zone community. Donations are although greatly appreciated and aid the development of this software. You can find donation links here.

If you find bugs or have some feedback, don't be afraid to let me know either on GitHub (using issues or pull requests) or on F95Zone (in the thread comments or in direct messages).

Please note that this software is not ( yet ;) ) officially affiliated with the F95Zone platform.

Cool people:

Supporters:

FaceCrap - ascsd - Jarulf - rozzic - warez_gamez - DarkVermilion - And 1 anon

Contributors:

Community:

abada25 - AtotehZ - bitogno - d_pedestrian - DarK x Duke - GrammerCop - MillenniumEarl - SmurfyBlue - yohudood - And others that I might be forgetting