@gorilla-engine-sdk/create-gorilla-engine-plugin 1.0.0

package/LICENSE.md

@@ -0,0 +1,64 @@
+**IMPORTANT NOTICE: PLEASE READ CAREFULLY BEFORE DOWNLOADING, INSTALLING OR USING THE GORILLA ENGINE SDK:**
+
+- BY SIGNING THIS AGREEMENT, OR CLICKING ON THE “ACCEPT” BUTTON BELOW (IF AVAILABLE), OR BY DOWNLOADING, INSTALLING, OR USING THE GORILLA ENGINE SDK, YOU AGREE TO THE TERMS OF THIS AGREEMENT, AND ALL INCORPORATED TERMS INCLUDING GORILLA ENGINE’S PRIVACY POLICY, AS APPLICABLE, WHICH WILL BIND YOU.
+
+- IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, WE WILL NOT LICENSE THE GORILLA ENGINE SDK TO YOU AND YOU MUST DISCONTINUE THE INSTALLATION OR DOWNLOAD PROCESS OR CEASE USE OF THE UJAM GORILLA ENGINE SDK.
+
+**GORILLA ENGINE FREE TIER LICENSE**
+
+This Gorilla Engine Free Tier License ("Agreement") is entered between UJAM, Inc., a Delaware corporation (hereinafter "UJAM" or "we") and you (“Licensee” or “you”) and becomes effective once you download, install, or use the GORILLA ENGINE SDK.
+
+1. OBJECT OF AGREEMENT. This Agreement governs UJAM’s GORILLA ENGINE SDK (“SDK”) and all related software and documentation and any update, upgrades or bug fixes (collectively referred to as the "UJAM GORILLA ENGINE SDK SERVICE").
+
+2. GRANT OF LICENSE: Subject to your full compliance with all of the terms and conditions of this Agreement, we grant you a non-exclusive, revocable, nonsublicensable (except as specifically provided herein), non-transferable license to use the UJAM GORILLA ENGINE SDK SERVICE solely to: (i) download, install, and use the UJAM GORILLA ENGINE SDK SERVICE for the sole purpose of building audio plugins such as virtual instruments and effects ("Application") and using such Application for music productions and live performances. **HOWEVER, YOU MUST NOT SHARE OR OTHERWISE EXPLOIT YOUR GORILLA ENGINE BASED APPLICATION WITH ANY THIRD PARTY UNTIL YOU HAVE ACQUIRED ONE OF THE ADD-ON LICENSES AS FURTHER DESCRIBED IN SECTION 8 OF THIS AGREEMENT.** If you have any questions regarding this license and allowed uses of the SDK, please reach out to us via email at support@gorilla-engine.com.
+
+3. LICENSE RESTRICTIONS AND OBLIGATIONS: Except as expressly and unambiguously authorized under this Agreement, you must not
+   1. copy, rent, lease, sell, transfer, assign, sublicense, disassemble, reverse engineer or decompile (except to the limited extent expressly authorized by applicable statutory law), modify, create derivative works from, or alter any part of the UJAM GORILLA ENGINE SDK SERVICE;
+   2. sublicense your Application to end-users until you have acquired a license as further described in Section 8 of this Agreement.
+   3. use any automated means, including, without limitation, agents, robots, scripts or spiders, to access the UJAM GORILLA ENGINE SDK SERVICE or bypass the UJAM GORILLA ENGINE SDK SERVICE or to interfere or attempt to interfere with the proper working of the UJAM GORILLA ENGINE SDK SERVICE;
+   4. use the UJAM GORILLA ENGINE SDK SERVICE as a dynamic-link library (for clarity: the SDK shall solely be used as a statically linked library); (g) use the SDK or any part of the SDK in connection with building or distributing your own or a third-party SDK or framework; or (h) use the Licensed Software to train artificial intelligence, your own or a third-party algorithm, and/or any other kind of machine learning processes.
+   5. use the UJAM GORILLA ENGINE SDK SERVICE for the benefit of a third party, other than end users of your Applications as expressly authorized by this Agreement;
+   6. use the UJAM GORILLA ENGINE SDK SERVICE to implement or enhance a product or service that is competitive with the UJAM GORILLA ENGINE SDK SERVICE;
+   7. modify and/or rename the UJAM binary libraries; or
+   8. otherwise engage in activity that interrupts the proper working of the UJAM GORILLA ENGINE SDK SERVICE or is otherwise fraudulent or illegal.
+
+Furthermore, you agree
+
+9. display attribution on all embodiments and uses of the Gorilla Engine SDK by displaying the language “powered by Gorilla Engine” ; and  
+   10. to contact UJAM once you intend to Distribute (as defined in Section 8\) your Application to obtain the appropriate license to do so – which you agree is required for such a scenario (as further described in Section 8 below).
+
+   We reserve the right to discontinue, modify, cease support of, and alter the pricing structure of this Agreement (the Gorilla Engine Free Tier License) of the UJAM GORILLA ENGINE SDK SERVICE.
+
+10. LICENSE TO UJAM: You hereby grant to us the non-exclusive, perpetual, worldwide, royalty-free right and license to any and all content ("Content") provided by you or your end users in connection with your use or your end users' use of the SDK, including but not limited to feedback or other contributions made towards the UJAM GORILLA ENGINE SDK SERVICE (including so-called re-usable components, made available by UJAM via its repositories), in order for us to provide and improve the UJAM GORILLA ENGINE SDK SERVICE. You represent and warrant that all Content provided by you shall not violate any third party rights and shall be free of any and all claims.
+
+11. REPRESENTATIONS AND WARRANTIES: You represent and warrant that you: (i) are fully authorized to enter into this agreement; (ii) shall use the UJAM GORILLA ENGINE SDK SERVICE in compliance with all applicable local, state, national and foreign laws, treaties and regulations, including those related to data privacy, international communications, export laws and the transmission of technical or personal data laws; (iii) shall not (and shall not permit any third party, including a permitted sublicensee to), directly or indirectly, take any action or upload, download, post, submit or otherwise distribute or facilitate distribution of Content or any material on or through the UJAM GORILLA ENGINE SDK SERVICE, that: (a) infringes any patent, trademark, trade secret, copyright, right of publicity/privacy or other right of any third party or induces infringement thereof; (b) breaches any third party contract or obligation; (c) is unlawful, threatening, abusive, harassing, defamatory, deceptive, fraudulent, invasive of another's privacy, tortious, obscene, offensive, or profane.
+
+12. OWNERSHIP AND PROPRIETARY RIGHTS: As between UJAM and Licensee (and any permitted sublicensees), the SDK and all intellectual property rights in and to the UJAM GORILLA ENGINE SDK SERVICE, are and shall at all times remain the sole and exclusive property of UJAM and are protected by applicable intellectual property laws and treaties. You shall not obscure, remove or otherwise alter our copyright or trademark notices or other proprietary rights' notices affixed to or within the SDK or elsewhere.
+
+13. SUPPORT AND UPGRADES: This Agreement does not entitle you to any support for the SDK, unless you enter into a separate agreement with us in writing, either signed by both parties or agreed upon via click-through agreement. Any such support provided by us shall be subject to the terms and disclaimers of this Agreement.
+
+14. ADD-ON LICENSES FOR A PERMITTED DISTRIBUTION OF GORILLA ENGINE BASED APPLICATION:
+    1. **Add-On Licenses (Upgrade to Pro Tier):** You agree to contact UJAM to obtain one of our commercial license (including the so-called “Pro Tier” License, including available optional Add-On upgrades which can be ) (collectively referred to as “Add-On Licenses”), whichever deemed to be appropriate for your intended use of the SDK, to Distribute (as defined below in subsection ii.) your Gorilla Engine based Application to end-users. Such Add-On License shall supersede this Agreement, as agreed to by the parties.
+    2. **Failure to comply with Section 8:** If you fail to comply with Section 8(i) by Distributing the SDK as part of an Application beyond the allowed use under this Agreement, you shall immediately contact UJAM and pay to UJAM a royalty per each Distribution (as defined below) in an amount as solely determined by UJAM. A Distribution refers to either an embedded, pre-bundled, pre-installed platform application or software application that is downloaded, delivered, or served to a user or device by any means of distribution including directly from you or through any platform, including cloud based platforms. In avoidance of doubt, any subscription or rental shall be considered a Distribution.
+    3. **Audit Rights**: Should (i) you fail to obtain an Add-On License and distribute the SDK as part of an Application, or should (ii) UJAM believe that you distribute the Application without having obtained an Add-On License, then UJAM shall have the right, upon reasonable notice, to audit/inspect any premises, computer(s), and networks on or in which the SDK is installed or used to monitor compliance with the terms of this Agreement, including but not limited to confirming the number of Distributions of the Application. If an audit reveals any unauthorized use, in addition to all other remedies available to UJAM, you shall be responsible to UJAM for all reasonable expenses related to the audit.
+    4. **Third Party Libraries:** You acknowledge that certain third-party libraries, including JUCE 6 ([https://juce.com/legal/juce-6-license/](https://juce.com/legal/juce-6-license/)), may be used in connection with the SDK, subject to their respective license agreements as further disclosed by UJAM. It is your sole responsibility to abide to such third-party terms, which may include your obligations, amongst others, to provide certain disclosures accompanying your Gorilla Engine based Software and/or acquiring a JUCE license (if applicable).
+
+15. DATA PROTECTION AND PRIVACY: We may collect and process information about you and your use of the Gorilla Engine SDK, some of which may amount to personal data, subject to Gorilla Engine’s Privacy Policy.
+
+16. TRADE SECRETS AND CONFIDENTIAL INFORMATION: You acknowledges that the SDK contains valuable trade secrets of UJAM and, should you access any such trade secrets in violation of this Agreement, you agree to maintain the confidentiality of the trade secrets of the SDK using at least the same degree of care that you use with your own confidential information.
+
+17. WARRANTY DISCLAIMER: THE UJAM GORILLA ENGINE SDK SERVICE, INCLUDING THE SDK, IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, WE DISCLAIM ALL WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, REGARDING THE UJAM GORILLA ENGINE SDK SERVICE, INCLUDING WITHOUT LIMITATION ANY AND ALL IMPLIED WARRANTIES OF MERCHANTABILITY, ACCURACY, RESULTS OF USE, RELIABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AVAILABILITY, PERFORMANCE, BANDWIDTH, AND NON-INFRINGEMENT OF THIRD-PARTY RIGHTS. FURTHER, WE DISCLAIM ANY WARRANTY THAT LICENSEE'S USE OF THE UJAM GORILLA ENGINE SDK SERVICE WILL BE AVAILABLE, UNINTERRUPTED OR ERROR FREE.
+
+18. LIABILITY LIMITATION: REGARDLESS OF WHETHER ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE OR OTHERWISE, AND EXCEPT FOR BODILY INJURY, IN NO EVENT WILL WE OR OUR CONTRACTORS, EMPLOYEES OR AFFILIATES BE LIABLE TO YOU OR TO ANY THIRD PARTY UNDER ANY TORT, CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHER LEGAL OR EQUITABLE THEORY FOR ANY LOST PROFITS, LOST OR CORRUPTED DATA, COMPUTER FAILURE OR MALFUNCTION, INFRINGEMENT, INTERRUPTION OF BUSINESS, OR OTHER SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING OUT OF THE USE OR INABILITY TO USE THE UJAM GORILLA ENGINE SDK SERVICE, EVEN IF WE HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGES AND WHETHER OR NOT SUCH LOSS OR DAMAGES ARE FORESEEABLE. IN NO EVENT SHALL OUR TOTAL LIABILITY TO YOU OR ANY THIRD PARTY EXCEED TEN USD DOLLARS. ANY CLAIM ARISING OUT OF OR RELATING TO THIS AGREEMENT MUST BE BROUGHT WITHIN ONE (1) YEAR AFTER THE OCCURRENCE OF THE EVENT GIVING RISE TO SUCH CLAIM.
+
+19. INDEMNITY: You agree that we shall have no liability whatsoever for your or your end users of the UJAM GORILLA ENGINE SDK SERVICE. You shall indemnify, defend and hold us harmless from any and all claims, damages, liabilities, costs, and fees (including reasonable attorneys' fees) arising from your or your end users' use of the UJAM GORILLA ENGINE SDK SERVICE or for any breach of this Agreement, including any breach of the representations and warranties you made herein.
+
+20. TERM AND TERMINATION: This Agreement shall continue until terminated as set forth in this Section. Either party may terminate this Agreement at any time, for any reason, or for no reason including, but not limited to, if you violate any provision of this Agreement. We reserve the right to cancel, amend, or modify the SDK at any time. Any termination of this Agreement shall also terminate the license granted hereunder. Upon termination of this Agreement for any reason, you shall immediately destroy and remove from all computers, hard drives, networks, and other storage media all copies of the SDK, and shall so certify to us that such actions have occurred (including all cached ephemeral copies). Sections 5 (“REPRESENTATIONS AND WARRANTIES”), 6 (“OWNERSHIP AND PROPRIETARY RIGHTS”), 10 (“TRADE SECRETS AND CONFIDENTIAL INFORMATION”), 11 (“WARRANTY DISCLAIMER”), 12 (“LIABILITY LIMITATION”), 13 (“INDEMNITY”), 16 (“GOVERNING LAW”), 18 (“GENERAL PROVISIONS”) shall survive termination of this Agreement.
+
+21. EXPORT CONTROLS: You shall comply with all applicable export laws and restrictions and regulations and you shall not export, or allow the export or re-export of the SDK in violation of any such restrictions, laws, or regulations.
+
+22. GOVERNING LAW: This Agreement shall be governed by New York law, excluding conflict of law provisions. The parties agree to and submit to the exclusive jurisdiction of courts located in New York City, New York. The application of the United Nations Convention of Contracts for the International Sale of Goods is expressly excluded.
+
+23. PREVAILING PARTY. Notwithstanding Section 12 (“LIABILITY LIMITATION”), in the event of any court action relating to enforcement of this Agreement, including injunctive relief, the non-prevailing party shall reimburse the prevailing party for all reasonable attorneys’ fees and costs, including expert witness fees, resulting therefrom.
+
+24. GENERAL PROVISIONS. If any part of this Agreement is found void or unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms. This Agreement may only be modified by written agreement between the Parties. Updates to the UJAM GORILLA ENGINE SDK SERVICE may be licensed to you by UJAM with additional or different terms. UJAM further reserves rights, in its discretion, not to license updates. This is the entire Agreement between UJAM and you relating to the UJAM GORILLA ENGINE SDK SERVICE and it supersedes any prior representations, discussions, undertakings, communications, or advertising relating to the UJAM GORILLA ENGINE SDK SERVICE. This Agreement is not assignable by you.

package/README.md

@@ -0,0 +1,103 @@
+# 🎛️ Create Gorilla Engine Plugin
+
+> Scaffold a Gorilla Engine plugin with a React and TypeScript user interface.
+
+`@gorilla-engine-sdk/create-gorilla-engine-plugin` generates a complete starting point for Gorilla Engine instrument and effect plugins.
+
+## Contents
+
+- [Prerequisites](#prerequisites)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+- [After Scaffolding](#after-scaffolding)
+- [License](#license)
+
+## 📋 Prerequisites
+
+- [Node.js](https://nodejs.org/)
+- A [Gorilla SDK](https://www.gorilla-engine.com/) installation
+
+The generator checks for the Gorilla Engine compiler before it runs. You can continue without it, but it is required to build the generated plugin.
+
+## 🚀 Quick Start
+
+Generate an instrument plugin interactively:
+
+```bash
+npx @gorilla-engine-sdk/create-gorilla-engine-plugin
+```
+
+Then move into the generated directory and build it:
+
+```bash
+cd your-plugin-folder
+npm run buildAndInstall
+npm start
+```
+
+## 💻 Usage
+
+### Install globally
+
+```bash
+npm install -g @gorilla-engine-sdk/create-gorilla-engine-plugin
+```
+
+### Interactive mode
+
+```bash
+create-gorilla-engine-plugin [folder]
+```
+
+When `folder` is omitted, the generator creates a folder named after the plugin. Otherwise, it generates the project in the supplied folder.
+
+### Non-interactive mode
+
+```bash
+create-gorilla-engine-plugin [folder] --manufacturer "Acme Audio" --name "Bass Forge" --effect
+```
+
+| Option                 | Description                                                   |
+| ---------------------- | ------------------------------------------------------------- |
+| `--manufacturer`, `-m` | Manufacturer name.                                            |
+| `--name`, `-n`         | Plugin name.                                                  |
+| `--effect`, `-f`       | Create an effect plugin. The default is an instrument plugin. |
+
+The generated project includes a Gorilla Engine project file (`.ugep`), a React and TypeScript UI, instrument and asset templates, and build/deploy scripts.
+
+## 🔧 After Scaffolding
+
+### ☁️ Build and install
+
+Build and install the plugin for local development:
+
+```bash
+npm run buildAndInstall
+```
+
+The plugin build is compiled in the cloud and may take a few minutes. Run it again when the `.ugep` file changes, such as when changing outputs, exposed parameters or something of that nature.
+
+The first time you run `npm run buildAndInstall` or `npm run build` on a machine, you will be prompted for the credentials which you signed up with on https://www.gorilla-engine.com/ and then credentials are stored user-wide so you don't have to provide them again:
+
+| Platform | Credential path                                    |
+| -------- | -------------------------------------------------- |
+| macOS    | `~/.gorilla-engine/credentials.json`               |
+| Windows  | `%USERPROFILE%\\.gorilla-engine\\credentials.json` |
+
+To override those credentials for a project, add an optional `buildCredentials.json` file to the project root.
+
+### 🔄 Develop
+
+```bash
+npm start
+```
+
+This starts the standalone plugin, deploys source changes automatically, and restarts the standalone application.
+
+- Build and install the plugin once before starting development mode.
+- In a DAW, re-instantiate the plugin after source updates.
+- The deploy script requires write access to the installed plugin output folder and prompts to repair permissions when necessary.
+
+## 📄 License
+
+Licensed under the [GORILLA ENGINE FREE TIER LICENSE](./LICENSE.md).

package/generator-gorilla-engine-plugin/app/index.js

@@ -0,0 +1,338 @@
+import Generator from 'yeoman-generator';
+import { randomBytes } from 'node:crypto';
+import chalk from 'chalk';
+import { v4 as uuidv4 } from 'uuid';
+import path from 'node:path';
+
+const gorillaHeadBanner = `
+                  ##############
+               ####-...-++-...-####
+             ###-.-####+---####-.-###
+            ##-.##+.          .+##.-##
+          ##.+#-                  -##.##
+         ##+-#-                    -#--##
+      #### .#+                      -#. ####
+     ##-   -#.                      .#-   -###
+    ##.    ##                        ##     ##
+   ##-     #+                        -#     .##
+   ##     -#.   .################-   .#+     ##
+  -#+     ##    -##-..++++++..-##-    ##     +#-
+   ##    .#-      ...+#-++-#+...      -#.    +#
+   ##-   +#         .###--###.         #+   .##
+    ##-  +#        .########+#-        #+  -##
+     ##+ .#-       +#..... -##+       .#. +##
+       #####.      -##########-      .#####
+           +#+      -########-      +#+
+             +##+     .+##+.     +##+.
+                -###-        -###-
+                   .+########+.
+`;
+
+const gorillaTextBanner = `
+  ____            _ _ _
+ / ___| ___  _ __(_) | | __ _
+| |  _ / _ \\| '__| | | |/ _  |
+| |_| | (_) | |  | | | | (_| |
+ \\____|\\___/|_|  |_|_|_|\\__,_|
+
+ _____             _
+| ____|_ __   __ _(_)_ __   ___
+|  _| |  _ \\ / _  | |  _ \\ / _ \\
+| |___| | | | (_| | | | | |  __/
+|_____|_| |_|\\__, |_|_| |_|\\___|
+             |___/
+`;
+
+const gradientStart = [59, 130, 246];
+const gradientEnd = [168, 85, 247];
+
+const colorizeBanner = (banner) => {
+  const lines = getBannerLines(banner);
+  const maxLineLength = lines.reduce((maxWidth, line) => Math.max(maxWidth, line.length), 0);
+  const maxDistance = Math.max(lines.length + maxLineLength - 2, 1);
+
+  return lines
+    .map((line, rowIndex) =>
+      Array.from(line, (char, columnIndex) => {
+        if (char === ' ') {
+          return char;
+        }
+
+        const distance = rowIndex + columnIndex;
+        const mix = distance / maxDistance;
+        const red = Math.round(gradientStart[0] + (gradientEnd[0] - gradientStart[0]) * mix);
+        const green = Math.round(gradientStart[1] + (gradientEnd[1] - gradientStart[1]) * mix);
+        const blue = Math.round(gradientStart[2] + (gradientEnd[2] - gradientStart[2]) * mix);
+
+        return chalk.rgb(red, green, blue)(char);
+      }).join(''),
+    )
+    .join('\n');
+};
+
+const getBannerLines = (banner) =>
+  banner.split('\n').filter((line, index, lines) => {
+    const isEdgeLine = index === 0 || index === lines.length - 1;
+    return !isEdgeLine || line.trim() !== '';
+  });
+
+const getDisplayWidth = (banner) =>
+  getBannerLines(banner).reduce((maxWidth, line) => Math.max(maxWidth, line.length), 0);
+
+const combineBannersSideBySide = (leftBanner, rightBanner, gap = 4) => {
+  const leftLines = getBannerLines(leftBanner);
+  const rightLines = getBannerLines(rightBanner);
+  const leftWidth = leftLines.reduce((maxWidth, line) => Math.max(maxWidth, line.length), 0);
+  const totalLines = Math.max(leftLines.length, rightLines.length);
+
+  return Array.from({ length: totalLines }, (_, index) => {
+    const leftLine = leftLines[index] ?? '';
+    const rightLine = rightLines[index] ?? '';
+
+    if (!rightLine) {
+      return leftLine;
+    }
+
+    return `${leftLine.padEnd(leftWidth)}${' '.repeat(gap)}${rightLine}`.trimEnd();
+  }).join('\n');
+};
+
+const fullBanner = combineBannersSideBySide(gorillaHeadBanner, gorillaTextBanner);
+const fullBannerWidth = getDisplayWidth(fullBanner);
+const headBannerWidth = getDisplayWidth(gorillaHeadBanner);
+
+const getBannerForTerminal = (terminalWidth = process.stdout.columns ?? 0) => {
+  if (terminalWidth >= fullBannerWidth) {
+    return fullBanner;
+  }
+
+  if (terminalWidth >= headBannerWidth) {
+    return gorillaHeadBanner;
+  }
+
+  return '';
+};
+
+const isPromptCancellationError = (error) =>
+  error?.name === 'ExitPromptError' ||
+  (typeof error?.message === 'string' && error.message.includes('SIGINT'));
+
+const createIdentifier = (value) => value.replace(/[^A-Z0-9]/gi, '').toLowerCase();
+
+const createFourCharacterCode = (value) =>
+  createIdentifier(value).toUpperCase().padEnd(4, 'X').slice(0, 4);
+
+const createHexCode = (value) =>
+  `0x${Array.from(value, (character) => character.charCodeAt(0).toString(16)).join('')}`;
+
+const pluginTemplates = {
+  effect: 'effect',
+  instrument: 'basic-synth',
+};
+
+const validateIdentity = (value, label) => {
+  if (typeof value !== 'string' || value.trim() === '') {
+    return `${label} is required`;
+  }
+
+  if (createIdentifier(value) === '') {
+    return `${label} must contain at least one letter or number`;
+  }
+
+  return true;
+};
+
+const validatePluginName = (value) => {
+  const identityValidation = validateIdentity(value, 'Plugin name');
+  if (identityValidation !== true) {
+    return identityValidation;
+  }
+
+  return /[\\/]/.test(value) ? 'Plugin name cannot contain path separators' : true;
+};
+
+export default class extends Generator {
+  // The name `constructor` is important here
+  constructor(args, opts) {
+    // Calling the super constructor is important so our generator is correctly set up
+    super(args, opts);
+
+    // Plugin Name
+    // Effect or instrument
+    // git repo
+
+    this.justCopy = (array) =>
+      array.forEach((item) =>
+        this.fs.copyTpl(this.templatePath(item), this.destinationPath(`./${item}`)),
+      );
+
+    this.answers = {
+      plugin_manufacturer: opts.cli?.manufacturer,
+      plugin_name: opts.cli?.name,
+      is_effect: opts.cli?.effect,
+    };
+
+    this.outputFolder = opts.cli?.folder ?? undefined;
+  }
+
+  async prompting() {
+    const prompts = [];
+
+    const addPromptIfNotSet = (name, message, options = { type: 'input' }) => {
+      if (this.answers[name] === undefined) {
+        prompts.push({ ...options, name, message });
+      } else {
+        console.log(chalk.whiteBright(`${name} is:`), chalk.cyan(this.answers[name]));
+      }
+    };
+
+    addPromptIfNotSet('plugin_manufacturer', 'Enter a manufacturer name for the new plugin:', {
+      type: 'input',
+      validate: (value) => validateIdentity(value, 'Manufacturer name'),
+    });
+    addPromptIfNotSet('plugin_name', 'Enter a name for the new plugin:', {
+      type: 'input',
+      validate: validatePluginName,
+    });
+    addPromptIfNotSet('is_effect', 'Do you want to create an effect plugin?', {
+      type: 'confirm',
+      default: false,
+    });
+
+    if (prompts.length > 0) {
+      const banner = getBannerForTerminal();
+      if (banner) {
+        console.log(colorizeBanner(banner));
+      }
+
+      try {
+        Object.assign(this.answers, await this.prompt(prompts));
+      } catch (error) {
+        if (isPromptCancellationError(error)) {
+          console.error('cancelled by user input');
+          process.exit(130);
+        }
+
+        throw error;
+      }
+    }
+  }
+
+  configuring() {
+    const manufacturerValidation = validateIdentity(
+      this.answers.plugin_manufacturer,
+      'Manufacturer name',
+    );
+    if (manufacturerValidation !== true) {
+      throw new Error(manufacturerValidation);
+    }
+
+    const pluginNameValidation = validatePluginName(this.answers.plugin_name);
+    if (pluginNameValidation !== true) {
+      throw new Error(pluginNameValidation);
+    }
+
+    console.log(
+      chalk.whiteBright('Generating plugin in folder:'),
+      chalk.cyan(this.outputFolder ?? this.answers.plugin_name),
+    );
+    const folder = this.outputFolder ?? this.answers.plugin_name;
+    const destPath = path.resolve(this.contextRoot, folder);
+    this.destinationRoot(destPath);
+    this.env.cwd = this.destinationPath();
+    process.chdir(destPath);
+  }
+
+  git() {
+    // NPM doesn't like .gitignore files and will not check them out
+    this.fs.copyTpl(this.templatePath('gitignore'), this.destinationPath(`.gitignore`));
+  }
+
+  workspace() {
+    this.justCopy(['.agents', '.vscode', '.prettierignore', 'prettierrc', 'tsconfig.json']);
+
+    const sanitizeForEnvVar = (s) => s.toUpperCase().replace(/[^A-Z0-9]/g, '_');
+
+    this.fs.copyTpl(
+      this.templatePath('.vscode_input/launch.json'),
+      this.destinationPath('./.vscode/launch.json'),
+      {
+        plugin_name: this.answers.plugin_name,
+        plugin_manufacturer: this.answers.plugin_manufacturer,
+        debug_env_var: `${sanitizeForEnvVar(this.answers.plugin_manufacturer)}_${sanitizeForEnvVar(this.answers.plugin_name)}_DEBUG_PORT`,
+      },
+    );
+
+    this.fs.copyTpl(this.templatePath('package.json'), this.destinationPath('./package.json'), {
+      ugep_filename: `${this.answers.plugin_name}.ugep`,
+      plugin_manufacturer: this.answers.plugin_manufacturer,
+      is_effect: this.answers.is_effect,
+    });
+  }
+
+  project() {
+    const plugin_manufacturer = this.answers.plugin_manufacturer;
+    const plugin_manufacturer_lower_nospaces = createIdentifier(plugin_manufacturer);
+    const manufacturer_code = createFourCharacterCode(plugin_manufacturer);
+    const manufacturer_code_hex = createHexCode(manufacturer_code);
+
+    const plugin_name = this.answers.plugin_name;
+    const plugin_name_lower_nospaces = createIdentifier(plugin_name);
+    const plugin_code = createFourCharacterCode(plugin_name);
+    const plugin_code_hex = createHexCode(plugin_code);
+
+    const ugep_filename = `${this.answers.plugin_name}.ugep`;
+
+    const is_effect = this.answers.is_effect;
+
+    const randomHex = Array.from({ length: 8 }, () =>
+      '0123456789ABCDEF'.charAt(Math.floor(Math.random() * 16)),
+    ).join('');
+
+    this.fs.copyTpl(this.templatePath('build.ugep'), this.destinationPath(`./${ugep_filename}`), {
+      manufacturer_name: plugin_manufacturer,
+      manufacturer_name_lower_nospaces: plugin_manufacturer_lower_nospaces,
+      manufacturer_code: manufacturer_code,
+      manufacturer_code_hex: manufacturer_code_hex,
+
+      plugin_name: plugin_name,
+      plugin_name_lower_nospaces: plugin_name_lower_nospaces,
+      plugin_code: plugin_code,
+      plugin_code_hex: plugin_code_hex,
+
+      is_effect: is_effect,
+      app_uuid: uuidv4(),
+      content_encryption_key: randomBytes(16).toString('hex'),
+    });
+
+    const pluginTemplate = is_effect ? pluginTemplates.effect : pluginTemplates.instrument;
+    this.fs.copy(this.templatePath(pluginTemplate), this.destinationPath());
+    this.fs.copy(this.templatePath('assets/fonts'), this.destinationPath('./assets/fonts'));
+
+    const templateInstrumentName = is_effect ? 'Reverb Example' : 'Basic Synth Example';
+    const instrumentPath = this.destinationPath(`instrument/${plugin_name}.inst`);
+
+    this.fs.move(this.destinationPath(`instrument/${templateInstrumentName}.inst`), instrumentPath);
+    this.fs.move(
+      this.destinationPath(`instrument/${templateInstrumentName}.txt`),
+      this.destinationPath(`instrument/${plugin_name}.txt`),
+    );
+    for (const blobPart of ['part1', 'part2']) {
+      this.fs.move(
+        this.destinationPath(`assets/instruments/${templateInstrumentName}_${blobPart}.blob`),
+        this.destinationPath(`assets/instruments/${plugin_name}_${blobPart}.blob`),
+      );
+    }
+
+    const instrument = this.fs.readJSON(instrumentPath);
+    instrument.Name = plugin_name;
+    instrument.Scripts = instrument.Scripts.map((script) =>
+      script['Script Path'] === `${templateInstrumentName}.txt`
+        ? { ...script, 'Script Path': `${plugin_name}.txt` }
+        : script,
+    );
+    this.fs.writeJSON(instrumentPath, instrument);
+
+    this.justCopy(['licence.txt', 'README.md']);
+  }
+}