Custom Libraries - Revision history

Manni: /* Getting Assets into the Right Formats */

2024-06-17T13:54:49Z

‎Getting Assets into the Right Formats

Manni: /* Getting Assets into the Right Formats */

2024-06-17T13:52:16Z

‎Getting Assets into the Right Formats

Manni: /* Getting Assets into the Right Formats */

2024-06-17T13:36:15Z

‎Getting Assets into the Right Formats

Justincc: /* Caution */

2013-03-13T23:34:08Z

‎Caution

MakoBot: Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name

2012-03-04T06:19:15Z

Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name

MakoBot: Robot: Cosmetic changes

2012-03-04T02:54:40Z

Robot: Cosmetic changes

Show changes

Rknop at 02:17, 16 July 2011

2011-07-16T02:17:51Z

Rknop: /* Generating Inventory and Asset Files */

2011-07-16T02:09:08Z

‎Generating Inventory and Asset Files

Rknop: /* Generating Inventory and Asset Files */

2011-07-16T02:08:13Z

‎Generating Inventory and Asset Files

Rknop at 02:06, 16 July 2011

2011-07-16T02:06:42Z

Show changes

← Older revision		Revision as of 13:54, 17 June 2024
Line 49:		Line 49:

	# Info: https://github.com/uclouvain/openjpeg		# Info: https://github.com/uclouvain/openjpeg
		+	# Never compress tile textures.

	# Set paths		# Set paths

@@ Line 47: / Line 47: @@
 import os
 import subprocess
 # Set paths

← Older revision		Revision as of 13:36, 17 June 2024
Line 44:		Line 44:
	Maybe one day there will be an updated script....		Maybe one day there will be an updated script....

		+	<source lang="python">
		+	import os
		+	import subprocess
		+
		+	# Set paths
		+	input_dir = '512png'
		+	output_dir = '512_converted_j2k'
		+
		+	# Create output directory if it doesn't exist
		+	if not os.path.exists(output_dir):
		+	os.makedirs(output_dir)
		+
		+	# Function to convert PNG to J2K
		+	def convert_png_to_j2k(input_path, output_path):
		+	command = [
		+	'opj_compress',
		+	'-i', input_path,
		+	'-o', output_path,
		+	'-r', '1' # Lossless compression
		+	]
		+	try:
		+	subprocess.run(command, check=True)
		+	print(f"Successfully converted: {input_path} -> {output_path}")
		+	except subprocess.CalledProcessError as e:
		+	print(f"Error converting {input_path}: {e}")
		+
		+	# Traverse the input directory and convert PNG files
		+	for filename in os.listdir(input_dir):
		+	if filename.lower().endswith('.png'):
		+	input_path = os.path.join(input_dir, filename)
		+	output_filename = os.path.splitext(filename)[0] + '.j2k'
		+	output_path = os.path.join(output_dir, output_filename)
		+	convert_png_to_j2k(input_path, output_path)
		+
		+	print("Conversion completed.")
		+	</source>

	=== Creating Asset Set XML Files ===		=== Creating Asset Set XML Files ===

@@ Line 182: / Line 182: @@
 == Caution ==
-(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSimulator server. I do not know if this is the case. If it is, it certainly complicates matters.)
+Library data is currently pulled from the region itself rather than the inventory service  So in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSimulator server.
-Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSimulator will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.
+This needs to change in the future so that library data is loaded directly into the inventory service from the robust server and distributed to individual grids on request (chiefly on user login).  This may place more strain on the inventory service, though in the case of inventory it may be more feasible to do a long lived cache of the data on the simulator-side.
 Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>[[updatelibrary.py]]</tt>.

@@ Line 4: / Line 4: @@
 = Library Overview =
-The library in OpenSim is described in the file <tt>bin/inventory/Libraries.xml</tt>. That file defines a number of other libraries, each of which have a file for folders and a file for items. The files described in <tt>Libraries.xml</tt> are read each time the server starts. (Note, however, that the viewer caches library information, so you may need to clear your cache viewer side to see changes you've made.)
+The library in OpenSimulator is described in the file <tt>bin/inventory/Libraries.xml</tt>. That file defines a number of other libraries, each of which have a file for folders and a file for items. The files described in <tt>Libraries.xml</tt> are read each time the server starts. (Note, however, that the viewer caches library information, so you may need to clear your cache viewer side to see changes you've made.)
-If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating these inventory XML files. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.
+If you want to add assets to the Library on your OpenSimulator server, there are two fundamental steps. The first is generating the assets, the second is generating these inventory XML files. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.
 If you want ready-to-import libraries, you could check out the [[Free Assets]] section...
@@ Line 12: / Line 12: @@
 = Generating Assets =
-The server also is able to bulk import asset sets. These asset sets are described in the file <tt>bin/assets/AssetSets.xml</tt>. Each asset set has its own XML file describing the assets, coupled with another file that has the actual asset data (image or text data). You can define new asset sets and add the XML file describing them to <tt>AssetSets.xml</tt>. When Robust (in grid mode) or OpenSim (in standalone mode) starts up, it looks at the AssetSets.xml file. It figures out which of the assets in the asset sets don't exist in its asset store, and adds them.
+The server also is able to bulk import asset sets. These asset sets are described in the file <tt>bin/assets/AssetSets.xml</tt>. Each asset set has its own XML file describing the assets, coupled with another file that has the actual asset data (image or text data). You can define new asset sets and add the XML file describing them to <tt>AssetSets.xml</tt>. When Robust (in grid mode) or OpenSimulator (in standalone mode) starts up, it looks at the AssetSets.xml file. It figures out which of the assets in the asset sets don't exist in its asset store, and adds them.
 == Generating Assets With the Viewer ==
@@ Line 58: / Line 58: @@
 = Generating Inventory Items =
-The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library; each library is defined by two XML files. One describes the folders in the library, (i.e. subfolders underneath a top folder that shows up underneath OpenSim Library), and the other describes the items in those folders. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the two XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library. You're done! Except that it's very painful, because it will involve copying and generating a lot of UUIDs. As such, except for the most trivial of libraries, you don't want to do this by hand.
+The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library; each library is defined by two XML files. One describes the folders in the library, (i.e. subfolders underneath a top folder that shows up underneath OpenSimulator Library), and the other describes the items in those folders. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the two XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library. You're done! Except that it's very painful, because it will involve copying and generating a lot of UUIDs. As such, except for the most trivial of libraries, you don't want to do this by hand.
 == Generating Inventory and Asset Files ==
@@ Line 69: / Line 69: @@
 * Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.
-For example, if you're making a library that will show up as a folder under the OpenSim Library folder as "My Awesome Library", you could build it inside the MyAwesomeAssetSet directory. Underneath that directory, make subdirectories named Textures, Clothing, Objects, and so forth. In the Textures directory, put your properlly formatted j2k files. Right now, the script only handles textures (.j2k), notecards (.txt), and scripts (.lsl).
+For example, if you're making a library that will show up as a folder under the OpenSimulator Library folder as "My Awesome Library", you could build it inside the MyAwesomeAssetSet directory. Underneath that directory, make subdirectories named Textures, Clothing, Objects, and so forth. In the Textures directory, put your properlly formatted j2k files. Right now, the script only handles textures (.j2k), notecards (.txt), and scripts (.lsl).
 In addition, in each directory you can put a file named "addassets.lis". You can list assets that are already in your grid's asset store here to be added to the library at the folder corresponding to the directory of each adassets.lis file. ''Any'' type of asset may be added to the library this way. This file is a series of lines, each of which follows the format
@@ Line 178: / Line 178: @@
 Run the script. (Run it with <tt>--help</tt> to get usage instructions.) It will go through the entire directory tree where you have put your asset files. It will read the Asset Set, Inventory Folder, and Inventory Item XML files that already exist. It will then add entries as necessary to those files for any new .j2k, .txt, or .lsl files in your directory tree, as well as for any new entries in any addassets.lis file.
-When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new asset set and your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets and add your entries to the library. Again, remember that the viewer caches the library list, so you may need to clear your cache on the viewer in order to get the current version of the library.
+When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new asset set and your new library. Next time you start up OpenSimulator or (in grid mode) Robust, it should import your assets and add your entries to the library. Again, remember that the viewer caches the library list, so you may need to clear your cache on the viewer in order to get the current version of the library.
 == Caution ==
-(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)
+(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSimulator server. I do not know if this is the case. If it is, it certainly complicates matters.)
-Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSim will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.
+Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSimulator will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.
 Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>[[updatelibrary.py]]</tt>.

@@ Line 47: / Line 47: @@
 ===Creating Asset Set XML Files===
-Once you have all your assets in the right format, you need to create the AssetSet XML file.  Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>.  For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>.  You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>.  You can use the python script updatelibrary.py to generate this file.  It will also generate the inventory XML files needed.  This script is documented [[#Generating_Inventory_and_Asset_Files|below]].
+Once you have all your assets in the right format, you need to create the AssetSet XML file.  Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>.  For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>.  You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>.  You can use the python script [[updatelibrary.py]] to generate this file.  It will also generate the inventory XML files needed.  This script is documented [[#Generating_Inventory_and_Asset_Files|below]].
@@ Line 62: / Line 62: @@
 ==Generating Inventory and Asset Files==
-The python script <tt>updatelibrary.py</tt> is able to generate asset and inventory XML files at the same time.  Basically, you maintain a tree of assets in an asset set directory, and run this script to sync the XML files with your tree.  (Note that at the moment it can only ''add'' assets; it will not delete them if you remove them frmo yoru tree.)  It is able to add both assets in your asset set, ''and'' pre-existing assets already in your grid's asset store (for which you don't have to add something to an asset set.)
+The python script <tt>[[updatelibrary.py]]</tt> is able to generate asset and inventory XML files at the same time.  Basically, you maintain a tree of assets in an asset set directory, and run this script to sync the XML files with your tree.  (Note that at the moment it can only ''add'' assets; it will not delete them if you remove them frmo yoru tree.)  It is able to add both assets in your asset set, ''and'' pre-existing assets already in your grid's asset store (for which you don't have to add something to an asset set.)
 In order to use it, you must:
@@ Line 186: / Line 186: @@
 Additionally, all of this may be obsolete in the future.  Rather than using this code, it's possible that OpenSim will use IAR files to define the library (or, perhaps, default items for avatars).  For the time being, though, try this.
-Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>updatelibrary.py</tt>.
+Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>[[updatelibrary.py]]</tt>.

@@ Line 174: / Line 174: @@
 |}
-(There is also the "None" inventory type, which has number -1.)
+(There is also the "None" inventory type, which has number -1.  Body Parts and Clothing are both wearables.)
 Run the script.  (Run it with <tt>--help</tt> to get usage instructions.)  It will go through the entire directory tree where you have put your asset files.  It will read the Asset Set, Inventory Folder, and Inventory Item XML files that already exist.  It will then add entries as necessary to those files for any new .j2k, .txt, or .lsl files in your directory tree, as well as for any new entries in any addassets.lis file.