Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 4.16 KB

README.md

File metadata and controls

94 lines (61 loc) · 4.16 KB

nichtparasoup

shield_pypi-python shield_pypi-version
shield_gh-workflow-test shield_sonar-quality shield_sonar-coverage


nichtparasoup is a hackspaces entertainment system. It randomly displays images from pr0gramm and reddit.
Other crawlers are currently removed, but might be back soon as plugins.

If you find an ImageCrawler for your favourite ImageBoard missing, feel free to write your own ImageCrawler for it.
Contribute it to the nichtparasoup project or use it as an independent plugin :-)

logo


At our hackspace k4cg we've been using it for years now.
It has proven to be a very non-invasive way of entertaining a crowd of nerds without having the noise and interruptions of videos or other stuff.

Here is what it looks like in your browser screenshot

and even better, on a video projector in your local hackspace! hackspace

How it works

Images are crawled from multiple public pre-configured sources.
No image is actually downloaded, only the URLs to images are gathered. Found images are kept in a list to make sure the same URL is never gathered twice.

To show the crawled images, nichtparasoup starts a web-server that displays a web UI.
The web UI fetches one random image URL from the nichtparasoup server at a time.

The web UI will load new images continuously, unless one of the following events happen:

  • paused manually in the web UI
  • scroll position in web UI is not on top
  • window or tab lost focus
  • web UI is in image theater/zoom mode
  • boss mode is active in web UI

In the web UI the images are downloaded from the original source. The original source is linked and marked by an icon. Just hover over or click the icon in the bottom right of an image to get there.

Every time nichtparasoup serves an image URL it also removes it from its list. This means an image URL is served only once - unless the server was reset. (This might change in the future)

Demo

Visit nicht.parasoup.de/demo/ to try it!

Install, Usage, Config, etc

see the docs.

License

MIT - see the LICENSE file for details.

Credits