Home

First setup

Set up the environment

1. Create a new repository for storing your extension's source files. You can make it Public or Private.

2. Create a folder called src (in GitHub or locally), and create another 2 folders according to your extension's package name. For example, if your extension's package name is com.yusufcihan.maths then your directory tree must be like this:

/src/com/yusufcihan/Maths/

3. Lastly, add your Java source code to the inner folder.

If you created the folders in your computer, upload the src folder with all subdirectories to the GitHub, you can do that by using drag-drop upload feature or with GitHub Desktop.

Install the GitHub action

4. Create a new GitHub actions file called build.yml in the /.github/workflows/ directory by typing .github/workflows/build.yml in the file name text box. GitHub will automatically create directories for slashes.

5. Now copy this snippet and paste to the your new build.yml file.

on: push
name: Build my extension
jobs:
  buildAIX:
    name: Build AIX
    runs-on: ubuntu-18.04
    steps:
    - uses: actions/checkout@master
    - name: Build AIX
      id: build_aix
      uses: ysfchn/appinventor-aix-action@master
      with:
          source: 'https://github.com/mit-cml/appinventor-sources.git'
    - name: Upload Artifact
      id: upload-artifact
      uses: actions/[email protected]
      with:
        name: ${{ steps.build_aix.outputs.file }}
        path: appinventor-sources/appinventor/components/build/extensions/${{ steps.build_aix.outputs.file }}

6. Commit changes, and wait for your extension to compile. When build finished successfully, you need to go "Actions" tab in your repository, find Artifacts button and get the your .aix file.

Done!

Extra steps

If you want to add additional JAR libraries to your extension, you can follow this guide.

Adding a new library

1. Fork mit-cml/appinventor-sources. Skip this step if you already forked App Inventor sources before.

2. Open appinventor > lib folder.

3. Create a folder in this directory (you can use the library name as folder name).

4. And upload JAR file in that folder.

Example:

5. Go back to the parent directory, and open components > build.xml file.

6. Edit the file and find CopyComponentLibraries section.

7. Copy this code and append to the CopyComponentLibraries section.

<copy toFile="${public.deps.dir}/library.jar" file="${lib.dir}/folderName/library.jar" />

8. Replace library word with jar library's file name which you uploaded in step #4. (In this case, file name is socket.io-client-1.0.0.jar)

9. Replace folderName word with folder name which you created recently in step #3. (In this case, folder name is socketio)

Example:

<copy toFile="${public.deps.dir}/socket.io-client-1.0.0.jar" file="${lib.dir}/socketio/socket.io-client-1.0.0.jar" />

10. Commit/save changes.

11. Go back to your build.yml file and replace App Inventor sources Git URL with your own fork's Git URL.

Referencing the library

To use libraries in your extension;

11. Go back to your extension's Java source.

12. Add library file name (.jar) to @UsesLibraries section.

13. Commit changes and you now have an extension which packaged with this .jar file! Note that library name must be same with .jar file which you uploaded in step #4.

---

That's it! If you have any other questions, you can create an Issue.