GDevelop/Extensions/FileSystem/JsExtension.js

/**
 * This is a declaration of an extension for GDevelop 5.
 * 
 * ℹ️ Run `node import-GDJS-Runtime.js` (in newIDE/app/scripts) if you make any change
 * to this extension file or to any other *.js file that you reference inside.
 * 
 * The file must be named "JsExtension.js", otherwise GDevelop won't load it. 
 * ⚠️ If you make a change and the extension is not loaded, open the developer console
 * and search for any errors.
 * 
 * More information on https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md
 */
module.exports = {
  createExtension: function (t, gd) {
    const extension = new gd.PlatformExtension();
    extension.setExtensionInformation(
      "FileSystem",
      t("Filesystem"),
      t(
        "Access the filesystem of the operating system."
      ),
      "Matthias Meike",
      "Open source (MIT License)"
    ).setExtensionHelpPath("/all-features/filesystem");

    extension
    .addCondition(
      "PathExists",
      t("File or directory exists"),
      t(
        "Check if the file or directory exists."
      ),
      t("The path _PARAM0_ exists"),
      t("Filesystem/Windows, Linux, MacOS"),
      "JsPlatform/Extensions/filesystem_path_exists24.png",
      "JsPlatform/Extensions/filesystem_path_exists32.png"
    )
    .addParameter("string", t("Path to file or directory"), "", false)
    .getCodeExtraInformation()
    .setIncludeFile(
      "Extensions/FileSystem/filesystemtools.js"
    )
    .setFunctionName("gdjs.fileSystem.pathExists");

    extension
      .addAction(
        "MakeDirectory",
        t("Create a directory"),
        t("Create a new directory at the specified path."),
        t("Create directory _PARAM0_"),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_create_folder24.png",
        "JsPlatform/Extensions/filesystem_create_folder32.png"
      )
      .addParameter("string", t("Directory"), "", false)
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.makeDirectory");

    extension
      .addStrExpression(
        "DesktopPath",
        t("Desktop folder"),
        t("Get the path to the desktop folder."),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getDesktopPath");

    extension
      .addStrExpression(
        "DocumentsPath",
        t("Documents folder"),
        t("Get the path to the documents folder."),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getDocumentsPath");

    extension
      .addStrExpression(
        "PicturesPath",
        t("Pictures folder"),
        t("Get the path to the pictures folder."),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getPicturesPath");

    extension
      .addStrExpression(
        "ExecutablePath",
        t("This games executable folder"),
        t("Get the path to this games executable folder."),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getExecutablePath");

    extension
      .addStrExpression(
        "UserdataPath",
        t("Userdata folder (For application settings)"),
        t("Get the path to userdata folder. (For application settings)"),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getUserdataPath");

    extension
      .addStrExpression(
        "TempPath",
        t("Temp folder"),
        t("Get the path to temp folder."),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getTempPath");

      extension
      .addStrExpression(
        "PathDelimiter",
        t("Path delimiter"),
        t("Get the operating system agnostic path delimiter."),
        t("Filesystem/Windows, Linux, MacOS"),
        "JsPlatform/Extensions/filesystem_folder24.png",
        "JsPlatform/Extensions/filesystem_folder32.png"
      )
      .getCodeExtraInformation()
      .setIncludeFile(
        "Extensions/FileSystem/filesystemtools.js"
      )
      .setFunctionName("gdjs.fileSystem.getPathDelimiter");

    return extension;
  },
  runExtensionSanityTests: function (gd, extension) { return []; },
};