Differences

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

--- user-guide:export-as-lib [2025/04/02 16:31] – [Package name] gaetan
+++ user-guide:export-as-lib [2025/05/27 00:25] (current) – barley1965
@@ Line 1: / Line 1: @@
-====== Project as Library ======
+====== Project as a Module Library ======
-Project can be exported as a library usable from other projects. The exported library makes all types (classes, modules, ...) and resources (images, shaders, ...) available for import.
+A project can be exported as a library usable from other projects. The exported library makes all types (classes, modules, ...) and resources (images, shaders, ...) available for import.
 These libraries are called module lib.
@@ Line 9: / Line 9: @@
 ===== Structure =====
-Module lib follow the structure of [[:dev-guide:creating-own-plugin|GroIMP plugins]]. Thus, how the lib is integrated is described in the ''plugin.xml'' file, automatically created when exported.
+Module lib follows the structure of [[:dev-guide:creating-own-plugin|GroIMP plugins]]. Thus, the way the lib is integrated is described in the ''plugin.xml'' file, automatically created when exported.
@@ Line 23: / Line 23: @@
 ==== Package name ====
-By default, .rgg types are compiled without a package. It makes them all visible from the same pool. However, for ensuring a uniqueness when importing module library, a package name is required during the export. GroIMP will use the given package name as default package during the compilation.
+By default, .rgg types are compiled without a package. It makes them all visible from the same pool. However, to ensure uniqueness when importing module library, a package name is required during the export. GroIMP will use the given package name as default package during the compilation.
-Thus, if the project contains type with named package, they will not be affected by the package name provided.
+Thus, if the project contains types with the named package, they will not be affected by the package name provided.
-The package name must follow java's specification on package name.
+The package name must follow java's specification on package names.
 ==== Reference wrapper ====
+GroIMP implicitly wraps all references call in the project to be exported as a module library to make them use the resources from the library.
+Suppose we have a project that contains a resource with the name "shaderleaf". When exported, the module that uses ''setShader(shader("shaderleaf"))'', needs to point at the resource from the module lib, and not at a possible "shaderleaf" in a newly opened project.
+The wrappers force the references to point at ''plg:pkg.Plugin:"shaderleaf"''.