GroIMP wiki

a part of grogra.de

User Tools

Site Tools

Trace:
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 16:34] – [Testing GroIMP for the first time] Timuser-manual:ch01 [2025/06/17 19:27] (current) – barley1965
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 or higher**. 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.  It will also provide you with the possibility to create a menu entry and a shortcut.
  
-====== Windows ======+==== Windows ====
  
-The windows exe is a executable file that will extract and install GroIMP on your computer.+The windows exe is an 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.+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, as we neither had the funding nor the time to go through the certification process.
  
  
Line 54: Line 45:
 {{:tutorials:beginnerstut_image8.png?82x73}} {{:tutorials:beginnerstut_image8.png?82x73}}
  
- +==== Mac OS ====
- +
-===== Mac OS =====+
  
  
Line 65: Line 54:
 into one  and the same directory). into one  and the same directory).
  
-After extraction of the zip-file, the following files, among others, are present in the installation+After extraction of the zip-file, the following files, amongst others, are present in the installation
 directory: directory:
  
Line 78: Line 67:
 distribution, legal notices and other information. Please read it carefully. If you distribution, legal notices and other information. Please read it carefully. If you
 have trouble with the installation procedure described in this manual, please consult have trouble with the installation procedure described in this manual, please consult
-the file `INSTALL` a solution.+the file `INSTALL` for a solution.
  
 `plugins` `plugins`
Line 91: Line 80:
  
  
-===== Ubuntu & Debian =====+==== Ubuntu & Debian ====
  
  
Line 100: Line 89:
 If this is not possible you can use ''sudo dpkg -i /path/to/groimp.deb'' in a command line. If this is not possible you can use ''sudo dpkg -i /path/to/groimp.deb'' in a command line.
  
-==== Increasing heap space on Linux ====+=== Increasing heap space on Linux ===
  
-If you want to start GroIMP with additional heap space you can do so from command line:+If you want to start GroIMP with additional heap space you can do so from the command line:
  
 <code> <code>
 groimp -Xmx Xmx5G groimp -Xmx Xmx5G
 </code> </code>
-===== Others =====+==== 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.  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.  +For this case we provide an archive with the compiled jar on the Gitlab release page.  
-This can then be execute with java -jar core.jar +This can then be executed with java -jar core.jar 
-====== Running GroIMP ======+ 
 +===== 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 the 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 136: 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. 
  
-==== Testing GroIMP for the first time ====+===== 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: After you followed the installation instruction and started the software, you should be able to proceed the steps shown in the animation below:
Line 147: Line 137:
  
 In the editor "GREEN" is replaced by "BLUE" (not easy to see) In the editor "GREEN" is replaced by "BLUE" (not easy to see)
-==== Additional Options ==== 
  
-=== 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+===== Trouble shoot ===== 
 + 
 + 
 +==== Windows: GroIMP doesn't start ==== 
 + 
 +Even if you have installed the right version of java it can happen that the GroIMP installer is picking a wrong version of Java from your system. {{ :tutorials:copy.png?100|}}  
 +In this case you have to edit the shortcut to enter the right path: 
 +1. Find java 21 on your computer (most likely somewhere in "C:\Program Files" 
 +2. Right click on the the GroIMP desktop shortcut and select Properties (see image on the right)  
 +3. In the Properties find the filled target (see image below)  
 +4. Change the first path to the javaw.exe of java 21. 
 +{{ :tutorials:prefrences.png?200 |}}  
 + 
 + 
 +==== GroIMP is too small / too large ==== 
 + 
 +On modern screens Java swing applications sometimes struggle with the scaling making the font and the buttons way too small. To fix this you can just manually scale it with the following [[#java_parameters | java parameter]]: 
 + 
 +<code> 
 +-Dsun.java2d.uiScale=2.5 
 +</code> 
 + 
 +Instead of 2.5 you can use whatever scale fits for your screen, you might 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 ==== 
 + 
 +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 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
  
 > **java -Xmx400m -jar path/to/core.jar** > **java -Xmx400m -jar path/to/core.jar**
  
-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 allocated 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 send parameters to GroIMP. These parameters need to be passed AFTER the //core.jar// file. E.g.
  
 > **java -jar core.jar --project-tree** > **java -jar core.jar --project-tree**
Line 165: 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.
Line 173: Line 192:
 GroIMP can also be started //headless//, from //CLI//, or //API//. GroIMP can also be started //headless//, from //CLI//, or //API//.
  
-To define which interface is used, when starting GroIMP you need to pass the parameter //-a//. E.g.+To define which interface is used when starting GroIMP you need to pass the parameter //-a//. E.g.
  
  > **java -jar core.jar -a api**  > **java -jar core.jar -a api**
Line 185: Line 204:
 Installation of Plugins for the Java Image I/O Framework. Installation of Plugins for the Java Image I/O Framework.
  
-GroIMP requires only a Java runtime environment in order to run. However, the capabilities of some parts of the Java runtime environment can be extended by the installation of additional plugins. GroIMP makes use of the Java Image I/O Framework which provides features such a pluggable architecture: The user may install plugins which add support for an image file format to the Java Image I/O Framework. If the standard installation of the Java runtime environment does not support an image file format you need, please consult the [[http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html|Java Image I/O pages]] for a suitable plugin.+GroIMP requires only a Java runtime environment in order to run. However, the capabilities of some parts of the Java runtime environment can be extended by the installation of additional plugins. GroIMP makes use of the Java Image I/O Framework which provides features such as a pluggable architecture: The user may install plugins which add support for an image file format to the Java Image I/O Framework. If the standard installation of the Java runtime environment does not support an image file format you need, please consult the [[http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html|Java Image I/O pages]] for a suitable plugin.
  
 ==== GroIMP Plugins ==== ==== GroIMP Plugins ====
  
-GroIMP is developed around a plugin architecture. New plugin can easily be added to your GroIMP installation by simply adding them to the loading directory of GroIMP. +GroIMP is developed around a plugin architecture. New plugins can easily be added to your GroIMP installation by simply adding them to the loading directory of GroIMP. 
  
 On startup GroIMP loads all plugins under its installed path/plugins, as well as plugins in the //user plugin path//. The //user plugin path// can be modified in the GroIMP options, and is by default at ~/.grogra.de-platform/plugins/.  On startup GroIMP loads all plugins under its installed path/plugins, as well as plugins in the //user plugin path//. The //user plugin path// can be modified in the GroIMP options, and is by default at ~/.grogra.de-platform/plugins/. 
user-manual/ch01.1748270097.txt.gz · Last modified: 2025/05/26 16:34 by Tim