|
|
@@ -1,10 +1,112 @@
|
|
|
-### Assets management
|
|
|
+### Asset management
|
|
|
|
|
|
-TO BE COMPLETED!
|
|
|
-This page might be completed with:
|
|
|
+Monkey2 provides an simple system for managing assets. This allows you to import and use images, files, fonts, and sounds in a consistent way, regardless of the target platform you are deploying to.
|
|
|
|
|
|
-import syntax (single data file, wildcards, @ directive for imports, ...?)
|
|
|
+For the following examples, assume a project folder structure like this:
|
|
|
|
|
|
-differences between stream/stream files, file system files and an explanation on assets management on mobile devices (packed datas)
|
|
|
+```
|
|
|
+main.monkey2
|
|
|
+images/image1.png
|
|
|
+images/image2.png
|
|
|
+sounds/sound1.wav
|
|
|
+sounds/sound2.wav
|
|
|
+```
|
|
|
|
|
|
-supported file formats for each target
|
|
|
+#### Importing Assets
|
|
|
+
|
|
|
+Import assets for use in your project by using an Import directive.
|
|
|
+
|
|
|
+```
|
|
|
+'individual files
|
|
|
+
|
|
|
+#Import "relative/local/path/to/your/file"
|
|
|
+
|
|
|
+'entire folders
|
|
|
+
|
|
|
+#Import "relaive/local/path/"
|
|
|
+```
|
|
|
+
|
|
|
+When importing entire folders, Make sure to include the trailing slash at the end to let the compiler know it's a folder.
|
|
|
+
|
|
|
+```
|
|
|
+'import the entire images subfolder
|
|
|
+
|
|
|
+#Import "images/"
|
|
|
+
|
|
|
+'import a specific sound
|
|
|
+
|
|
|
+#Import "sounds/sound1.wav"
|
|
|
+```
|
|
|
+
|
|
|
+These import directives can go anywhere in your source file, but standard practice is to put them at the top of the file.
|
|
|
+
|
|
|
+#### Using Imported Assets
|
|
|
+
|
|
|
+Once you've imported your assets, you can reference them by prefixing the imported filename with `asset::`
|
|
|
+This allows you to use them with an function or method that asks for a String path to a file.
|
|
|
+
|
|
|
+```
|
|
|
+#Import "images/image1.png"
|
|
|
+
|
|
|
+Local myImage:Image = Image.Load("asset::image1.png")
|
|
|
+```
|
|
|
+
|
|
|
+If you imported a folder containing several assets, you can reference any of the assets in this way.
|
|
|
+
|
|
|
+```
|
|
|
+#Import "images/"
|
|
|
+
|
|
|
+Local image1:Image = Image.Load("asset::image1.png")
|
|
|
+Local image2:Image = Image.Load("asset::image2.png")
|
|
|
+
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
+#### Importing into a subfolder with "@/"
|
|
|
+
|
|
|
+If you want to maintain a folder structure when importing, you can specify a target subfolder with `@/target/path/` after the path in the import directive.
|
|
|
+
|
|
|
+```
|
|
|
+'imports image1.jpg into a subfolder called images
|
|
|
+
|
|
|
+#Import "images/image1.jpg@/images/"
|
|
|
+```
|
|
|
+
|
|
|
+`@/` also works when importing entire folders:
|
|
|
+
|
|
|
+```
|
|
|
+'imports everything from images/ into a subfolder called data/
|
|
|
+
|
|
|
+#Import "images/@/images/"
|
|
|
+```
|
|
|
+
|
|
|
+The destination folder name doesn't have to be the same as the source folder name.
|
|
|
+```
|
|
|
+'imports everything from images/ into a subfolder called data/
|
|
|
+
|
|
|
+#Import "images/@/data/"
|
|
|
+```
|
|
|
+
|
|
|
+When using the files in your code, make sure to add the target subfolder after `asset::`, for example:
|
|
|
+
|
|
|
+```
|
|
|
+#Import "images/image1.png@data/"
|
|
|
+
|
|
|
+Local image:Image = Image.Load("asset::data/image1.png")
|
|
|
+```
|
|
|
+
|
|
|
+#### Supported File Types
|
|
|
+
|
|
|
+Each target platform supports different file types. Consult the tables below for your target platform.
|
|
|
+
|
|
|
+##### Images
|
|
|
+
|
|
|
+| Desktop | Android | iOS | HTML5 |
|
|
|
+| --- | --- | --- | --- |
|
|
|
+| png, jpg | png, jpg, bmp, gif | png, jpg, bmp, gif, tif | png, jpg |
|
|
|
+
|
|
|
+##### Sounds
|
|
|
+
|
|
|
+| Desktop | Android | iOS | HTML5 |
|
|
|
+| --- | --- | --- | --- |
|
|
|
+| wav, ogg | wav, ogg, m4a, mp3 | wav, mp3, m4a, caf, aiff | wav, ogg, mp3, m4a |
|
Alan Rawkins