{"id":401,"date":"2021-12-02T22:15:39","date_gmt":"2021-12-02T22:15:39","guid":{"rendered":"https:\/\/writingagame.com\/?p=401"},"modified":"2021-12-02T22:19:08","modified_gmt":"2021-12-02T22:19:08","slug":"chapter-8-external-data-files-android-assets","status":"publish","type":"post","link":"https:\/\/writingagame.com\/index.php\/2021\/12\/02\/chapter-8-external-data-files-android-assets\/","title":{"rendered":"Chapter 8. External data files, Android assets"},"content":{"rendered":"\n

The idea is the same as in previous chapter – to place the data files within the reach of the executable. However, in Android’s case we are dealing NOT with the “executable”, but with APK. Besides, we have to deliver data files not just to different folder, but to different device. The only “transport” (known to me) is a special “assets<\/strong>” folder that can be embedded into APK, that will be eventually installed on destination device. So, let’s create it.<\/p>\n\n\n\n

1. Start Visual Studio, open C:\\CPP\\a999hello\\p_android\\p_android.sln<\/em> solution.
Right-click on p_android.Packaging<\/em> project (NOT p_android.NativeActivity<\/em> as usual, but p_android.<\/em>Packaging<\/em> <\/strong>). Add -> New Folder<\/strong><\/em>, call it assets<\/strong>. It’s a special reserved name, p_android.Packaging<\/em> will know what to do with it.<\/p>\n\n\n\n

\n\n\n\n

2. Now, open p_android.NativeActivity<\/em> project Properties, All Configurations \/ ARM64, go to Configuration Properties -> Build Events -> Post-Build Event -> Command Line -> Edit<\/em>, add command<\/p>\n\n\n\n

xcopy \"..\\..\\..\\engine\\dt\\*.*\" \"..\\$(RootNamespace).Packaging\\assets\\dt\\\" \/E \/R \/D \/y<\/code><\/pre>\n\n\n\n
<\/p>\n\n\n\n
Ok, Apply, Ok<\/p>\n\n\n\n
Clarification:<\/p>\n\n\n\n
 “..\\..\\..\\engine\\dt\\*.*<\/strong>”  – copy from. Unlike in Windows, here we have to go 1 folder level higher.<\/p>\n\n\n\n
“..\\$(RootNamespace).Packaging\\assets\\dt\\” – copy to where. Since this command will be executed from  p_android.NativeActivity<\/em>  folder, we need to step 1 folder level up and proceed to  p_android.Packaging<\/em> folder and then to assets<\/em>.<\/p>\n\n\n\n
The rest is the same as for Windows.<\/p>\n\n\n\n
\n\n\n\n
  1. VS top menu -> Build -> Rebuild Solution<\/em>. Result: \u201c2 succeeded, 0 failed, 0 skipped\u201d.<\/li><\/ol>\n\n\n\n
    Now, if we open C:\\CPP\\a999hello\\p_android\\p_android.Packaging\\assets<\/em> folder (in Windows File Explorer<\/strong>, not in VS), we’ll find there our “dt”. Now it’s also supposed to be included in the APK as well. But, to my big surprise, it is not. No trace of test0.txt file in the APK (which is located at C:\\CPP\\a999hello\\p_android\\p_android.Packaging\\ARM64\\Debug<\/em>).<\/p>\n\n\n\n
    \n\n\n\n
    4. It turned out that we had to manually add each file and folder to assets, as we usually do with program files (right-click, add item, and so on). This is a BIG problem. Obviously, we will have a huge number of these files and folders: shaders, models, textures, etc. It is simply impossible to keep track of this. We need to somehow force the assets folder to automatically fetch its contents.<\/p>\n\n\n\n
    The solution did not come easy, had to dive VERY deep, but NOW I know<\/p>\n\n\n\n
    How to add files to Android assets in Visual Studio<\/h2>\n\n\n\n
    In Android Studio (as opposed to Visual Studio), anything placed in the assets <\/em>folder will be automatically included into APK. To reproduce this behavior, we need to edit p_android.Packaging<\/em> project file:<\/p>\n\n\n\n
    Close Visual Studio.<\/p>\n\n\n\n
    In a Text Editor<\/strong> open C:\\CPP\\a999hello\\p_android\\p_android.Packaging\\p_android.Packaging.androidproj<\/em><\/p>\n\n\n\n
    Scroll down. Closer to the end you will see the section:<\/p>\n\n\n\n
      <ItemGroup>\n    <Content Include=\"res\\values\\strings.xml\" \/>\n    <AntBuildXml Include=\"build.xml\" \/>\n    <AndroidManifest Include=\"AndroidManifest.xml\" \/>\n    <AntProjectPropertiesFile Include=\"project.properties\" \/>\n  <\/ItemGroup>\n<\/code><\/pre>\n\n\n\n
    In the top of this section add:<\/p>\n\n\n\n
    <Content Include=\"assets\\**\" \/><\/code><\/pre>\n\n\n\n
    so the section will now be:<\/p>\n\n\n
    \n  <ItemGroup>\n    <Content Include="assets\\**" \/>\n    <Content Include="res\\values\\strings.xml" \/>\n    <AntBuildXml Include="build.xml" \/>\n    <AndroidManifest Include="AndroidManifest.xml" \/>\n    <AntProjectPropertiesFile Include="project.properties" \/>\n  <\/ItemGroup>\n\n<\/pre><\/div>\n\n\n
    <\/p>\n\n\n\n
    Save<\/strong>.<\/p>\n\n\n\n
    \n\n\n\n
    5. Start Visual Studio, open  C:\\CPP\\a999hello\\p_android\\p_android.sln<\/em> solution.<\/p>\n\n\n\n
    Top menu -> Build -> Rebuild solution<\/em>. Result: “2 succeeded, 0 failed, 0 skipped”.<\/p>\n\n\n\n
    Now, if you open C:\\CPP\\a999hello\\p_android\\p_android.Packaging\\ARM64\\Debug\\p_android.apk<\/em> in a text editor<\/strong>, you can make sure that the test0.txt file is there.<\/p>\n\n\n\n
    <\/p>\n\n\n\n
    <\/p>\n\n\n\n
    \n\n\n\n
    6. So now we can read the file on Android?? Most certainly. The code: <\/p>\n\n\n
    \n\t\/\/reading test file\n\tchar buff[256];\n\tAAssetManager* am = androidApp->activity->assetManager;\n\tAAsset* asset = AAssetManager_open(am, "dt\/shaders\/test0.txt", AASSET_MODE_UNKNOWN);\n\tif (asset != NULL) {\n\t\tlong size = AAsset_getLength(asset);\n\t\tAAsset_read(asset, buff, size);\n\t\tmylog("File size = %d, text:\\n%s\\n", size, buff);\n\t\tAAsset_close(asset);\n\t}\n\telse {\n\t\tmylog("Asset not found.\\n");\n\t}\n\n<\/pre><\/div>\n\n\n
    <\/p>\n\n\n\n
    Open main.cpp<\/em>. Scroll down. Insert this code right before theGame.run()<\/em>.<\/p>\n\n\n\n
    Switch on, unlock <\/strong>and plug in Android, allow debugging.<\/p>\n\n\n\n
    • Open Logcat first (VS top menu -> Tools -> Android Tools -> Logcat<\/em>), in search field type “mylog<\/strong>“, Enter. If necessary – clean the screen (red cross icon in Logcat’s menu).<\/li><\/ul>\n\n\n\n
      Now – build and run (green arrow). Re-open Logcat if closed. Result:<\/p>\n\n\n\n
      <\/p>\n\n\n\n
      <\/p>\n\n\n\n
      Now what? Shaders??<\/p>\n\n\n\n
      No, not yet, not yet\u2026<\/p>\n\n\n\n
      <\/p>\n\n\n\n
      <\/p>\n\n\n\n
      To be continued\u2026<\/p>\n\n\n\n
      \n","protected":false},"excerpt":{"rendered":"
      The idea is the same as in previous chapter – to place the data files within the reach of the executable. However, in Android’s case we are dealing NOT with the “executable”, but with APK. Besides, we have to deliver data files not just to different folder, but to different device. The only “transport” (known […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-401","post","type-post","status-publish","format-standard","hentry","category-cross-platform-3d"],"_links":{"self":[{"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/posts\/401","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/comments?post=401"}],"version-history":[{"count":13,"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/posts\/401\/revisions"}],"predecessor-version":[{"id":417,"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/posts\/401\/revisions\/417"}],"wp:attachment":[{"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/media?parent=401"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/categories?post=401"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/writingagame.com\/index.php\/wp-json\/wp\/v2\/tags?post=401"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}