Add Microsoft Windows Support and install via local PIP

pronopython · May 8, 2023 · d4cde87 · d4cde87
1 parent 60a06eb
commit d4cde87
Show file tree

Hide file tree

Showing 50 changed files with 945 additions and 137 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -10,6 +10,29 @@ Fly over thumbnails and zoom in on any image anytime in an instant!
 
 ![](img/7.jpg)
 
+
+Image Landscape generation from your directory structure:
+
+![](img/rugivi6.gif)
+
+Zooming and wandering around:
+
+![](img/rugivi1.gif)
+
+![](img/rugivi2.gif)
+
+Double click preview:
+
+![](img/rugivi3.gif)
+
+Always visible, floating Fapel Tables:
+
+![](img/rugivi4.gif)
+
+
+
+![](img/2306.png)
+
 Zoom in (screenshot is obviously censored ;-) )
 
 ![](img/0.jpg)
@@ -30,6 +53,8 @@ The pattern like structure between pictures and red empty spots on the right is
 
 ![](img/8.png)
 
+
+
 # Benefits
 
 * Works with hundreds of thousands of images **at the same time**
@@ -44,58 +69,107 @@ The pattern like structure between pictures and red empty spots on the right is
 
 
 
-# Installation
-
+# Requirements
 
-## Check Prerequisites
-
-* Linux (was written on Ubuntu, should work on all big distros) Works probably on MacOS and Windows when tweaked
+* Microsoft Windows or Ubuntu Linux (was written on Ubuntu, should work on all big distros). Works probably on MacOS when tweaked
 * 8 GB RAM or more
 * Python 3
 * PIP Python Package Manager
 
 
-## Clone this repository
+# Installation
+
 
-Currently there is no install script, so clone this repository into a writeable directory.
-Make all .py files executeable.
-RuGiVi will run inside this dir and also create its databases there.
-The database can be up to a few GB in size.
+## Ubuntu Linux Installation
 
-## Install needed Python modules
+### 1. Clone this repository
 
-Install TKinter for Python
+Clone this repository into a writeable directory.
+
+### 2. Install python tkinter
 
 `sudo apt-get install python3-tk`
 
-- TKinter is used for some Dialogs
+### 3. Install RuGiVi via pip
+
+In the repo's root run
+
+`chmod +x install_ubuntu.sh`
+
+`./install_ubuntu.sh`
+
+It installs RuGiVi via Python's PIP and creates start menu entries.
+
+> :cherries: *Do not run the install_ubuntu.sh as root (sudo), as it would create config files for root user and not for you*
 
-Install Python Modules
+### 4. Configure RuGiVi
 
-`pip install pygame psutil numpy sqlitedict`
+Proceed with [Configure RuGiVi](#configure-rugivi) (you need to do this!)
 
-- pygame draws the screen
-- psutil is needed to show memory usage
-- numpy to calculate some 2D Arrays
-- sqlitedict for thumb and world database
 
-## Edit config file
 
-Edit `rugivi.conf`:
 
-`crawlerRootDir=` is the root directory of all the pictures you want to explore within RuGiVi.
+## Windows Installation
+
+
+### 1. Clone or download this repo
+
+Yes, clone or download this repo now!
+
+### 2. Install Python
+
+Download and install Python 3
+
+[https://www.python.org/downloads/windows/](https://www.python.org/downloads/windows/)
+
+
+### 3. Install RuGiVi via pip
+
+Start (doubleclick) `install_windows.bat`
+
+It installs RuGiVi via Python's PIP and creates the start menu entries.
+
+
+### 4. Configure RuGiVi
+
+Proceed with [Configure RuGiVi](#configure-rugivi) (you need to do this!)
+
+
+
+# Configure RuGiVi
+
+
+Run `rugivi_configurator`:
+
+![](img/2302.png)
+
+Change the entries to fit your setup.
+
+|Setting      | Description                                                                              |
+|-----------------|------------------------------------------------------------------------------------|
+|Crawler root directory       | This is the root directory of all the pictures you want to explore within RuGiVi |
+|Crawler World DB File | This is the database file the "world" (the position of all files on the screen) is saved to|
+|Thumb DB File| The Database containing all thumbnails. *This can be several GB in size!*|
+|Reverse Scroll Wheel Zoom| Changes the direction for zooming. Set it "true" when using a trackpad|
+| Status font size | Font size of the grey status area|
+| FapTable parent dirs | See FapTables |
+| FapTable single dirs | See FapTables |
+
+
+
 
 
 # Start RuGiVi
 
-Open the installation directory in terminal and start RuGiVi:
+You can start RuGiVi via the start menu entry.
 
+![](img/2301.png)
 
-`./rugivi.py`
+![](img/2303.png)
 
-(Start menu entries etc will follow in a later release ;-) )
+RuGiVi opens with an additional terminal window showing some log.
 
-You now want to maximise the window.
+You now want to maximise the main window.
 
 You can toggle the grey info box by pressing `i` repeatly.
 
@@ -138,15 +212,83 @@ Close RuGiVi by closing the main window ("x"). If it works and all databases and
 
 Sometimes RuGiVi hangs up during shutdown (a known bug). If so, please go into the command line and kill RuGiVi with Ctrl+C.
 
+# FapTables
+
+FapTables are a way to always keep specific media in the view floating over the world view all the time.
+
+Here you can see the red catsuit images floating over the world view. When the world view is moved, the images stay at that position on the screen:
+
+![](img/3100.png)
+
+You can have more than one of these "tables" or "desk". And you can rearrange the images via the Fapel Table Edit Mode (pressing the mouse wheel).
+
+![](img/rugivi4.gif)
+
+![](img/rugivi5.gif)
+
+One table equals one directory you specify in the RuGiVi Configurator. This is the directory that was presented as the fapel table above:
+
+![](img/3105.png)
+
+It contains all the media and a file called ftpositions.json, which RuGiVi saves the positions of the images on screen.
+
+
+## Fapel Table Edit Mode
+
+The images are not arranged when you open a new Fapel Table or when new images are added:
+
+![](img/3101.png)
+
+Press wheel button / middle mouse button to enter the edit mode:
+
+![](img/3102.png)
+
+Now drag images to your fav position and resize them (drag rectangle at bottom right corner of an image):
+
+![](img/3103.png)
+
+Switch back to explorer mode by pressing wheel / middle mouse button again:
+
+![](img/3104.png)
+
+
+## Switching between Fapel Tables
+
+
+You can switch between different Fapel Tables with the cursor keys.
+You start at the top "(off)" (no fapel table is presented) and when you press down, you get the first fapel table created from the first subdir of the first parent dir you specify in the configurator.
+
+In this example pressing "down" gets you into the dir "20220101" from the parent directory "Fapsets" you specified in the configurator under "FapTable parent dirs":
+
+![](img/4312.png)
+
+Switch between all subdirs by pressing left and right arrow keys.
+
+In the example, pressing right opens faptable from directory 20220201.
+
+
+Pressing further down switches through all subdirs of all parent dirs.
+
+In the example, pressing down gets you to 0001 of the Ct parent dir.
+
+The last set of directories are the "single dirs" where all the directories are presented next to each other.
+
+
+## Switching off Fapel Tables
+
+To switch off the display of fapel tables just press "up" arrow key until you reach "(off)" so no fapel table is presented.
+
+
 # Troubleshooting
 
 
 
 |Problem        |Solution                                                     |
 |---------------|-------------------------------------------------------------|
+| RuGiVi does not start| Try starting RuGiVi via console (with `rugivi`) and look at the error messages. Common reasons is a broken or incorrect config file. You can also try to define new world and thumb database files.|
 |Screen is black|Probably Edit mode is enabled, press middle mousebutton again|
-|               |                                                             |
-|               |                                                             |
+|Images are pixelated or just red    | RuGuVi is probably loading a lot of images and the ones you currently want to see are at a later position at the loader queue. Keep an eye on "Queue" in the information box (                                                       press `i` to show it) |
+|RuGiVi is slow               |   Loading takes time and RuGiVi loads a lot of data. See the Tips section for speed tips. |                                                          |
 |               |                                                             |
 
 
@@ -155,10 +297,13 @@ Sometimes RuGiVi hangs up during shutdown (a known bug). If so, please go into t
 
 * Speed up loading thumbs and images from the Queue: The queue can easily reach 50000 pictures / thumbs at once when zooming out. Switching to FapelTable by pressing middle mousebutton stops the drawing of the world
 
-# Known bugs
+* You can speed up everything by using a fast SSD and a lot of RAM. When running inside a virtual machine make sure the machine has enough virtual processors, a lot of RAM and its disk files are on SSDs.
+
+# Known bugs and limitations
 * Quit does not work everytime. The crawler then runs in an infinite loop.
 * Sometimes the garbage collection is not run or runs too late and memory is depleted (rugivi can easily grab gigabytes of RAM of course). You then get an out-of-memory error.
-
+* Despite not changing anything, RuGiVi does not work on read-only media directories. This is because pygame image loader opens files with write access.
+* TIFF files may produce warnings which on Windows are opened as separate message boxes.
 
 # Technical Stuff
 
@@ -167,3 +312,34 @@ A Frame is placed onto a spot.
 Spots are grouped into chunks. Every Chunk contains 32 x 32 = 1024 Spots (and thus, a maximum of 1024 images)
 
 RuGiVi has its own garbage collection which is called "housekeeping" which runs every 5 minutes.
+
+## Information display
+
+Press `i` a few times to show the information display.
+
+
+|Info        | Description                                                    |
+|------------|----------------------------------------------------------------|
+|FPS         |Frames per second                                               |
+|Center Pixel  | Your current position is shown in x/y Pixels and Spots|
+| Center Spot | Your current position in x/y spot coordinates. This are the values you can use with the go-to option pressing `g`|
+|Height| Zoom height|
+|Selected Spot| The Spot highlighted with selection. Again you can use these coordinates with the go-to option pressing `g`|
+|Disk Access Total Loaded| How many times had an image/media file been loaded from disk ("File") or as a thumbnail from the thumb database ("DB")|
+|DB Size| Number of images in the thumb database|
+|ImgDrawn| Drawn images on screen|
+|maxDrawRounds|How many drawing rounds per Frame|
+|MemP|Used memory reported by OS|
+|MemI|Used memory only for images calculated by RuGiVi's Image Server|
+|ImgServer| Images in memory: T=Thumb Size, G=Grid Size, S=Screen Size, O=Original (Full) Size|
+|World loaded| How many chunks and frames are in memory|
+|Crawler Status| saving to db = DB is written do disk, sleeping = so the crawler does not eat all process power, correcting border = creating the border around the newly fetched frames/spots, fetching next dir = scanning dir, finding biome = finding a place in the world for all media of the scanned dir
+|Crawler Dir| The current directory which is scanned|
+|Selected Image| The currently selected image|
+|Queue| Image Server Queue (both Disk and DB access)|
+
+
+
+
+
+
diff --git a/img/2301.png b/img/2301.png
diff --git a/img/2302.png b/img/2302.png
diff --git a/img/2303.png b/img/2303.png
diff --git a/img/2304.png b/img/2304.png
diff --git a/img/2305.png b/img/2305.png
diff --git a/img/2306.png b/img/2306.png
diff --git a/img/2307.png b/img/2307.png
diff --git a/img/2308.png b/img/2308.png
diff --git a/img/3100.png b/img/3100.png
diff --git a/img/3101.png b/img/3101.png
diff --git a/img/3102.png b/img/3102.png
diff --git a/img/3103.png b/img/3103.png
diff --git a/img/3104.png b/img/3104.png
diff --git a/img/3105.png b/img/3105.png
diff --git a/img/4312.png b/img/4312.png
diff --git a/img/rugivi1.gif b/img/rugivi1.gif
diff --git a/img/rugivi2.gif b/img/rugivi2.gif
diff --git a/img/rugivi3.gif b/img/rugivi3.gif
diff --git a/img/rugivi4.gif b/img/rugivi4.gif
diff --git a/img/rugivi5.gif b/img/rugivi5.gif
diff --git a/img/rugivi6.gif b/img/rugivi6.gif