GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace: • ch01
user-manual:ch01

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
user-manual:ch01 [2025/05/26 14:47] – [Download] Timuser-manual:ch01 [2025/05/31 09:55] (current) – [Requirements] tim2
Line 1: Line 1:
-====== Table of Contents ====== +====== Installation ======
-    * [[:User-Manual:ch01#system_requirements|System Requirements]] +
-    * [[:User-Manual:ch01#download|Download]] +
-    * [[:User-Manual:ch01#install_from_binaries|Installation from binaries]] +
-    * [[:User-Manual:ch01#running_groimp|Running GroIMP]] +
-      * [[:User-Manual:ch01#running_groimp|From a Shortcut]] +
-      * [[:User-Manual:ch01#running_groimp|From the Command Line]] +
-      * [[:User-Manual:ch01#running_groimp|Additional Options]] +
-      * [[:User-Manual:ch01#running_groimp|GroIMP Interfaces]] +
-    * [[:User-Manual:ch01#plugin_architecture|Plugin Architecture]]+
  
-====== Requirements ======+===== Requirements =====
  
 GroIMP is written in Java, which means it should follow Java's WORA-principle (Write Once, Run GroIMP is written in Java, which means it should follow Java's WORA-principle (Write Once, Run
Line 16: Line 7:
 successfully on Mac, Linux and  Windows platforms. successfully on Mac, Linux and  Windows platforms.
  
-GroIMP 2.2 requires the installation of a  Java runtime environment of version 21. This +GroIMP 2.2 requires the installation of a **Java runtime environment of version 21**. This 
-can be obtained from Oracle at [[https://www.oracle.com/de/java/technologies/downloads/#jdk21-windows]].+can be obtained from Oracle at [[https://www.oracle.com/de/java/technologies/downloads/#java21]].
  
 For a reasonably performant runtime behaviour, at least 256 MB RAM and a 1 GHz processor are For a reasonably performant runtime behaviour, at least 256 MB RAM and a 1 GHz processor are
 recommended. recommended.
  
-====== Download ======+===== Download =====
  
 The binary distribution of GroIMP  is available on our website [[https://download.grogra.de/|download.grogra.de]] as a zip-file, windows exe, or Debian/Ubuntu release. The binary distribution of GroIMP  is available on our website [[https://download.grogra.de/|download.grogra.de]] as a zip-file, windows exe, or Debian/Ubuntu release.
Line 28: Line 19:
  
  
-====== Installation from binaries ======+===== Installation from binaries ===== 
 + 
 + It will also provide you with the possibility to create a menu entry and a shortcut. 
 + 
 +==== Windows ==== 
 + 
 +The windows exe is a executable file that will extract and install GroIMP on your computer. 
 + 
 +While you are downloading the file you might get some warning from your web browser that the software is not certified by Microsoft. Please ignore this warning, we do not found the funding and the time to go through the certification process. 
 + 
 + 
 +Please double click on the downloaded file (make sure you have administrator rights on your machine for installation), and follow the instructions one by one: 
 + 
 +{{:tutorials:beginnerstut_image4.png?293x204}} {{:tutorials:beginnerstut_image5.png?295x202}} 
 + 
 +Normally, click on ‘I Agree’, then on ‘Next’. Choose the destination folder, then the maximum heap size for Java. This allocates a certain amount of RAM (random access memory) to the Java Virtual Machine on which GroIMP is running. By default, 1500 MB are allocated, but you can allocate up to 50 per cent of the RAM available on your machine to Java, without any problem (so on a machine with 10 GB RAM you can enter 5000):\\ 
 +{{:tutorials:beginnerstut_image6.png?284x193}} {{:tutorials:beginnerstut_image7.png?282x192}} 
 + 
 +After this you click on ‘Install’ and wait for the installation to finish (this can take more than ten minutes). 
 + 
 +After the installation, a folder “GroIMP-2.2” should be available under something like this address: “C:\Program Files\”. 
 + 
 +GroIMP will now be available either on your desktop or in the list of programmes: 
 + 
 +{{:tutorials:beginnerstut_image8.png?82x73}} 
 + 
 +==== Mac OS ==== 
  
-The windows exe and debian release are executable files that will extract and install GroIMP on your computer. It will also provide you with the possibility to create a menu entry and a shortcut. 
 Mac users need to download the zip-file, extract it and run GroIMP from the command line. Mac users need to download the zip-file, extract it and run GroIMP from the command line.
  
Line 62: Line 79:
 environment to start the GroIMP application. environment to start the GroIMP application.
  
-====== Running GroIMP ======+ 
 +==== Ubuntu & Debian ==== 
 + 
 + 
 +The .deb file is an executable file that will extract and install GroIMP on your computer. 
 + 
 +In most modern Ubuntu systems you can just click on the downloaded deb file and it will open the package manager which allows you to install the software. 
 + 
 +If this is not possible you can use ''sudo dpkg -i /path/to/groimp.deb'' in a command line. 
 + 
 +=== Increasing heap space on Linux === 
 + 
 +If you want to start GroIMP with additional heap space you can do so from command line: 
 + 
 +<code> 
 +groimp -Xmx Xmx5G 
 +</code> 
 +==== Others ==== 
 + 
 + 
 +As a java software it is possible to execute GroIMP on any system that can run a java virtual machine of version 21. This includes almost any version of Linux as well as some other systems.  
 +For this case we provide a archive with the compiled jar on the gitlab release page.  
 +This can then be execute with java -jar core.jar 
 + 
 +===== Running GroIMP =====
  
 Because `core.jar` is an executable java archive, it is possible to start GroIMP just by (double-)clicking on the file in your system's file browser as you would do with a usual executable file. This requires a suitable setup of your file browser, see the documentation of the browser and your Java installation if it does not already work. Because `core.jar` is an executable java archive, it is possible to start GroIMP just by (double-)clicking on the file in your system's file browser as you would do with a usual executable file. This requires a suitable setup of your file browser, see the documentation of the browser and your Java installation if it does not already work.
  
-==== From a Shortcut ====+=== From a Shortcut ===
  
 You can set up your desktop to show a menu entry for GroIMP. How this is done depends on your system. Usually your system provides a menu editor where you can create a new menu entry and specifiy the command to be executed when the entry is activated. Choose the command as you would do on command line. You can set up your desktop to show a menu entry for GroIMP. How this is done depends on your system. Usually your system provides a menu editor where you can create a new menu entry and specifiy the command to be executed when the entry is activated. Choose the command as you would do on command line.
  
-==== From the Command Line ====+=== From the Command Line ===
  
 The file `core.jar` in your installation directory of GroIMP's binary distribution is the entry-point for starting GroIMP. Running GroIMP from the command line is easy: The file `core.jar` in your installation directory of GroIMP's binary distribution is the entry-point for starting GroIMP. Running GroIMP from the command line is easy:
Line 85: Line 126:
  
 Alternatively, if you wish to start GroIMP from a batch file from your cmd console in Windows, you could write a file called groimp.bat (which you would place in your home directory, C:\\Users\\myself\\, where 'myself' is your user directory) with the following content: Alternatively, if you wish to start GroIMP from a batch file from your cmd console in Windows, you could write a file called groimp.bat (which you would place in your home directory, C:\\Users\\myself\\, where 'myself' is your user directory) with the following content:
-> **cd "C:\Program Files\GroIMP 2.1.5"**+> **cd "C:\Program Files\GroIMP 2.2"**
 > **"C:\Program Files\Java\jdk-22\bin\javaw.exe" -Xmx3000m -Xss20M -noverify -jar core.jar** > **"C:\Program Files\Java\jdk-22\bin\javaw.exe" -Xmx3000m -Xss20M -noverify -jar core.jar**
  
 where "C:\Program Files\Java\jdk-22\bin\javaw.exe" is an example of the placement of your javaw version, assuming we use jdk22.  where "C:\Program Files\Java\jdk-22\bin\javaw.exe" is an example of the placement of your javaw version, assuming we use jdk22. 
  
-==== Additional Options ====+===== Testing GroIMP for the first time ===== 
 + 
 +After you followed the installation instruction and started the software, you should be able to proceed the steps shown in the animation below: 
 +{{ :user-manual:test_groimp.gif |}} 
 + 
 +In the editor "GREEN" is replaced by "BLUE" (not easy to see) 
 + 
 + 
 +===== Trouble shoot ===== 
 + 
 + 
 +==== Windows: GroIMP doesn't start ==== 
 + 
 +Even if you installed the right version of java it can happen that the GroIMP installer is picking an wrong one from your system. {{ :tutorials:copy.png?100|}}  
 +In this case you have to edit the short cut to enter the right path: 
 +1. Find java 21 on your computer (most likely some where in "C:\Program Files" 
 +2. Right click on the the GroIMP desktop short cut and select properties (see image on the right)  
 +3. In the preference find the filed target (see image below)  
 +4. change the first path to the javaw.exe of java 21. 
 +{{ :tutorials:prefrences.png?200 |}}  
 + 
 + 
 +==== GroIMP is to small / to large ==== 
 + 
 +On modern screen java swing application sometimes struggle with the scaling making the font and the buttons way to small. To fix this you can just manually scale it with the following [[#java_parameters | java parameter]]: 
 + 
 +<code> 
 +-Dsun.java2d.uiScale=2.5 
 +</code> 
 + 
 +In stead of 2.5 you can place what ever scale fits for your screen, maybe you will have to try this out a few times. 
 + 
 +To apply this on windows please refer to ([[#windowsgroimp_doesn_t_start | Windows: GroIMP doesn't start ]] and to apply this on Debian/Ubuntu to [[#increasing_heap_space_on_Linux | Increasing heap space on Linux]]. 
 + 
 + 
 +===== Additional Options =====
  
-=== Java Parameters ===+==== Java Parameters ====
  
 The **java** command has several options that influence the runtime behaviour, see the documentation of your Java installation. These options have to be specified before the `-jar` option. E.g., for the Java runtime environment of Sun, the option `-Xmx` specifies the maximum amount of heap memory size that should be allocated. The default value of this option may be much smaller than your installed main memory size. In this case GroIMP cannot benefit from your memory until you specify the `-Xmx` option as in The **java** command has several options that influence the runtime behaviour, see the documentation of your Java installation. These options have to be specified before the `-jar` option. E.g., for the Java runtime environment of Sun, the option `-Xmx` specifies the maximum amount of heap memory size that should be allocated. The default value of this option may be much smaller than your installed main memory size. In this case GroIMP cannot benefit from your memory until you specify the `-Xmx` option as in
Line 100: Line 176:
 which allows a maximum heap memory allocation of 400 MB. If you encounter `OutOfMemoryError`s when running GroIMP, you have to specify this option with a larger value. Note that the opposite may happen, i.e. a too generous memory allocation might prevent GroIMP from starting at all. In that case you have to lower the alocated memory again until it works.  which allows a maximum heap memory allocation of 400 MB. If you encounter `OutOfMemoryError`s when running GroIMP, you have to specify this option with a larger value. Note that the opposite may happen, i.e. a too generous memory allocation might prevent GroIMP from starting at all. In that case you have to lower the alocated memory again until it works. 
  
-=== GroIMP Parameters ===+==== GroIMP Parameters ====
  
 The command line also enables to provides parameters to GroIMP. These parameters need to be passed AFTER the //core.jar// file. E.g. The command line also enables to provides parameters to GroIMP. These parameters need to be passed AFTER the //core.jar// file. E.g.
Line 108: Line 184:
 The complete list of GroIMP parameters can be found [[:user-guide:advanced-groimp-arguments|here]]. The complete list of GroIMP parameters can be found [[:user-guide:advanced-groimp-arguments|here]].
  
-==== GroIMP Interfaces ====+===== GroIMP Interfaces =====
  
 See [[:user-guide:additional_interfaces|GroIMP interfaces]] for more details and tutorials. See [[:user-guide:additional_interfaces|GroIMP interfaces]] for more details and tutorials.
user-manual/ch01.1748263670.txt.gz · Last modified: 2025/05/26 14:47 by Tim