tt/AutoJs6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
174a52b5a25792f4b8d2a30222a4d05e170063a7
AutoJs6/.readme/README-en.md

51 KiB
Raw Blame History

autojs6-banner_800×224

JavaScript automation tool supporting accessibility service on the Android platform

GitHub release (latest by date) GitHub closed issues Created
Rhino Android Studio
CodeFactor Grade JetBrains supporter GitHub License

Languages

The current README.md supports the following languages:

Introduction

Auto.js is a JavaScript automation tool software for the Android platform that supports Accessibility Service.

Auto.js was first released by hyb1996 on 2017/01/27 and ceased maintenance on 2020/03/13, with the final version name being 4.1.1 Alpha2 and build number 461.

AutoJs6 is based on the final project of Auto.js, undergoing secondary development on 2021/12/01 and continues to be open-source and free.

The table below lists some Auto.js-related projects (sorted by development date):

Project App Name Developer Development Start Date Development End Date
Auto.js Auto.js hyb1996 2017/01/27 2020/03/13
Auto.js Pro 7 Auto.js hyb1996 2019/03/13 2019/07/08
Auto.js Pro 8 AutoJsPro hyb1996 2019/10/13 2021/07/24
Auto.js Auto.js M TonyJiangWJ 2019/11/21 -
AutoX Autox.js kkevsekk1 2020/07/24 -
Auto.js Pro 9 AutoJsPro hyb1996 2021/03/28 2023/02/09
AutoJs6 AutoJs6 SuperMonster003 2021/12/01 -
AutoX Autox.js v6 wilinz 2022/05/26 -
AutoX Autox.js v7 aiselp 2024/04/21 -

The dates in the table are estimated and may differ from actual dates.

Auto.js Pro 7/8/9 in the table are paid versions, and the rest are free open-source versions.

Functions

  • Can be used as a JavaScript IDE (code completion/variable renaming/code formatting)
  • Supports automation based on Accessibility Service
  • Supports floating button quick actions (script recording and running/view package name and activity/layout analysis)
  • Supports Selector API and provides control traversal/information retrieval/control operations (similar to UiAutomator)
  • Supports layout interface analysis (similar to Android Studio's LayoutInspector)
  • Supports recording functionality and playback of recorded actions
  • Supports screen capture/save screenshots/color search in images/image matching
  • Supports E4X (ECMAScript for XML) for interface writing
  • Supports packaging script files or projects into APK files
  • Supports expanded functionality using Root privileges (screen click/slide/record/Shell)
  • Supports use as a Tasker plugin
  • Supports connection with VSCode for desktop development (requires AutoJs6-VSCode-Extension plugin)

Environment

  • Android Operating System
  • API 24 (7.0) [N] and above

Manual

Major Changes

Compared to the final open-source version 4.1.1 Alpha2 of Auto.js, the main upgrades or changes in AutoJs6 are:

  • Supports obtaining ADB privileges through Shizuku and using system API
  • Supports building WebSocket instances to perform network requests based on the WebSocket protocol
  • New modules [ base64 / crypto / sqlite / i18n / notice / ocr / opencc / qrcode / shizuku / ... ]
  • Multilingual support [ Spanish / French / Russian / Arabic / Japanese / Korean / English / Simplified Chinese / Traditional Chinese / ... ]
  • Theme color adaptation [ Grouping / Location / Search / History / Automatic Adaptation of Brightness and Contrast / ... ]
  • Night mode adaptation [ Settings page / Documentation page / Layout analysis page / Floating window / ... ]
  • VSCode plugin supports both client (LAN) and server (LAN/ADB) connection methods
  • Rhino engine upgraded from v1.7.7.2 to v1.8.1-SNAPSHOT

Version Histories

v6.6.2

2025/04/16
  • Feature Methods such as ui.statusBarAppearanceLight, statusBarAppearanceLightBy, navigationBarColor, etc.
  • Feature ui.statusBarHeight attribute (getter) for obtaining the status bar height issue #357
  • Feature images.flip method for image flipping issue #349
  • Feature Added "file extension" option in the settings page
  • Feature New layout support in the theme color settings page (grouping, positioning, search, history, enhanced color palette, etc.)
  • Fix Issue where Android 15's status bar background color did not match the theme color
  • Fix Issue where the plugins.load method failed to properly load plugins issue #290
  • Fix Issue where the dx library could not be used properly on Android 7.x issue #293
  • Fix Potential synchronization issues in ScriptRuntime when using require to import built-in modules (tentative fix) issue #298
  • Fix Issue where the notice module was missing extension methods such as getBuilder issue #301
  • Fix Issue where methods like shizuku/shell could not accept string parameters issue #310
  • Fix Issue where the colors.pixel method could not accept single-channel image parameters issue #350
  • Fix Issue where methods such as engines.execScript/execScriptFile had abnormal default working directories when executing scripts issue #358 issue #340 issue #339
  • Fix Issue where floaty.window/floaty.rawWindow could not be executed on background threads
  • Fix Issue where floaty.getClip might not correctly retrieve clipboard content issue #341
  • Fix Issue where ui.inflate returned values were missing prototype methods such as attr/on/click
  • Fix Issue where incorrect scope context binding when using XML syntax to use a JavaScript expression as an attribute value issue #319
  • Fix Issue where exceptions in some method calls could not be caught by try..catch blocks issue #345
  • Fix Issue where generating code on the layout analysis page could cause the app to crash issue #288
  • Fix Issue where packaged applications could not properly use the shizuku module issue #227 issue #231 issue #284 issue #287 issue #304
  • Fix Issue in the code editor where jumping to the end of a line might actually move the cursor to the beginning of the next line
  • Fix Issue where rapid consecutive clicks on dialog-type items in the settings page could cause the app to crash
  • Improvement Streamlined the APK file size for the packaged application template
  • Improvement Enhanced app (and packaged apps) support for more permissions issue #338
  • Improvement Added support for the Pinyin library option on the packaging page
  • Improvement Optimized the status bar background and text color on the main activity page of packaged apps
  • Improvement Added special permission toggles (such as access all files and send notifications) to the packaged app settings page issue #354
  • Improvement Automatically switched control text and icon colors based on the brightness of the theme color
  • Improvement Improved visual experience when contrast between control theme color and background is too low
  • Improvement Enhanced HEX input control in the color palette for better compatibility when pasting color values from the clipboard
  • Improvement Set in-app navigation bar to be transparent or semi-transparent to enhance visual experience
  • Improvement Default UI mode for status bar and navigation bar set to md_grey_50 color in light mode
  • Improvement Homepage drawer's accessibility service toggle now syncs with script code
  • Improvement Homepage document page search now supports bidirectional find buttons
  • Improvement Homepage "Files" tab now supports toggling floating button visibility via long press
  • Improvement Code editor title text now supports auto-adjusting font size
  • Improvement Log page floating button visibility now linked with list scrolling actions
  • Improvement Script project configuration file project.json now supports more packaging options issue #305 issue #306
  • Improvement Improved project.json to support lenient matching of option names and alias compatibility
  • Improvement APK file type info dialog now includes file size and signature scheme information
  • Improvement APK file type info dialog now supports click listeners for copying text and navigating to app details
  • Improvement Attempted to restore com.stardust prefixed packages to improve code compatibility issue #290
  • Improvement Enhanced floaty.window/floaty.rawWindow to support execution on both main and background threads
  • Improvement Global getClip method now leverages floaty.getClip as needed to improve compatibility
  • Improvement Improved compatibility when passing null paths to files.path and related methods
  • Improvement Synchronized with the latest official upstream code of the Rhino engine and performed necessary code adaptations
  • Improvement Enhanced README.md to better document project build and run instructions issue #344
  • Improvement Some dependency or local library version adjustments CHANGELOG.md

v6.6.1

2025/01/01
  • Feature Pinyin module for Chinese Pinyin conversion (Refer to Project Documentation > Chinese Pinyin)
  • Feature Pinyin4j module for Chinese Pinyin conversion (Refer to Project Documentation > Chinese Pinyin)
  • Feature Methods UiObject#isSimilar and UiObjectCollection#isSimilar for determining whether a control or a collection of controls is similar
  • Feature Global method "currentComponent", used to obtain the name information of the currently active component
  • Fix Issue where the project could not compile properly in certain environments due to a rollback to an earlier version
  • Fix "Non-primitive value" exception that may occur when calling non-existent methods
  • Fix Issue where script shortcuts could not be added properly on certain devices (tentative fix) issue #221
  • Fix Incorrect parameter type restrictions for the automator.click/longClick methods issue #275
  • Fix Issue where selectors did not support ConsString type parameters issue #277
  • Fix Missing methods and properties on UiObjectCollection instances
  • Improvement The packaging page supports signature configuration, keystore management, and permission settings (by luckyloogn) pr #286
  • Improvement Improved accuracy in identifying the current package name and activity name of the floating window (Priority: Shizuku > Root > A11Y)
  • Improvement Improved accuracy in recognizing currentPackage and currentActivity (Priority: Shizuku > Root > A11Y)
  • Improvement Restore the ability to select text content of individual entries in the log activity window via double-click or long press issue #280
  • Improvement Recover as much critical information as possible for script projects when project.json is corrupted
  • Improvement Automatically convert Simplified Chinese to Pinyin (including multi-tone characters) for generated package name suffixes when packaging single files
  • Improvement Support for negative arguments in the UiSelector#findOnce and UiSelector#find methods
  • Improvement Enhanced adaptability of app.startActivity/startDualActivity methods
  • Improvement UI elements and className-related selectors now support more package name prefix omission forms (e.g., RecyclerView, Snackbar, etc.)
  • Improvement Synchronize with the latest upstream code of the Rhino engine and adapt it to the existing project
  • Improvement Some dependency or local library version adjustments CHANGELOG.md

v6.6.0

2024/12/02 - Built-in module rewrite, upgrade cautiously
  • Hint The built-in modules are rewritten in Kotlin to enhance script execution efficiency, but iterative improvements are needed.
  • Hint The built-in init.js file is empty by default, allowing developers to extend built-in modules or mount external modules.
  • Feature Axios module / Cheerio module (Ref to AutoX)
  • Feature SQLite module for simple operations on SQLite databases (Ref to Auto.js Pro) (See project documentation > SQLite)
  • Feature MIME module for processing and parsing MIME type strings (See project documentation > MIME)
  • Feature Nanoid module for string ID generation (Ref to ai/nanoid)
  • Feature Sysprops module for obtaining runtime environment configuration data (See project documentation > System Properties)
  • Feature OCR module supports Rapid OCR engine
  • Feature Layout analysis supports window switching (Ref to Auto.js Pro)
  • Feature auto.clearCache method supports clearing control caches (Ref to Auto.js Pro)
  • Feature threads.pool method supports simple application of thread pools (Ref to Auto.js Pro)
  • Feature images.matchTemplate method adds useTransparentMask option parameter to support transparent image search (Ref to Auto.js Pro)
  • Feature images.requestScreenCaptureAsync method for asynchronously requesting screenshot permissions in UI mode (Ref to Auto.js Pro)
  • Feature images.requestScreenCapture method adds isAsync option parameter to support asynchronous screenshot capture (Ref to Auto.js Pro)
  • Feature images.on('screen_capture', callback) and other event listener methods support listening for screen capture availability events (Ref to Auto.js Pro)
  • Feature images.stopScreenCapture method supports actively releasing resources related to screenshot applications (Ref to Auto.js Pro)
  • Feature Images.psnr/mse/ssim/mssim/hist/ncc and images.getSimilarity methods for obtaining image similarity metrics
  • Feature images.isGrayscale method for determining whether an image is grayscale
  • Feature images.invert method for negative image conversion
  • Feature s13n.point/time methods for standardizing point objects and duration objects (See project documentation > Normalization)
  • Feature console module's gravity, touchThrough, backgroundTint methods (See project documentation > Console)
  • Feature Mathx.randomInt/Mathx.randomFloat methods for returning random integers or random floating-point numbers within a specified range
  • Feature app.launchDual/startDualActivity methods for handling dual app launch (Requires Shizuku or Root permissions) (Experimental)
  • Feature app.kill method for forcefully stopping an app (Requires Shizuku or Root permissions)
  • Feature floaty.getClip method for indirectly obtaining clipboard content using a floating window
  • Fix Memory leak in View Binding of Fragment subclasses (e.g., DrawerFragment / ExplorerFragment)
  • Fix Instance memory leak in classes such as ScreenCapture / ThemeColorPreference
  • Fix Issue causing app crash when requesting screenshot permissions on Android 14 (by chenguangming) pr #242
  • Fix Issue causing app crash when starting foreground service on Android 14
  • Fix Issue with run button in code editor not lighting up properly on Android 14
  • Fix App may not run properly after packaging due to missing necessary library files issue #202 issue #223 pr #264
  • Fix App crash when editing project due to missing specified icon resources issue #203
  • Fix Unable to use parameters properly to obtain screenshot resources of specified screen orientation when requesting screenshot permissions
  • Fix Issue with some devices unable to add script shortcuts properly (Trial fix) issue #221
  • Fix Cumulative request sending delay issue with methods related to sending requests in http module issue #192
  • Fix Shizuku service may not work properly before AutoJs6 enters the main activity page (Trial fix) issue #255
  • Fix random(min, max) method may have out-of-bounds results
  • Fix Issue where result type parameter of pickup methods cannot be properly passed empty arrays
  • Fix Issue where control rectangle obtained by UiObject#bounds() may be inadvertently modified, breaking its immutability
  • Fix Issue with text/button/input elements where text containing half-width double quotes cannot be parsed properly
  • Fix Issue with text/textswitcher elements where autoLink attribute functionality fails
  • Fix Issue with different scripts erroneously sharing the same ScriptRuntime object
  • Fix Issue with global variables HEIGHT and WIDTH losing dynamically-generated Getter properties
  • Fix Issue with potential high-latency startup caused by RootShell loading on script startup
  • Fix Issue with floating console window background color setting leading to loss of rectangular rounding style
  • Fix Access service auto-start may encounter abnormal service issues (Trial fix)
  • Fix Issue with triggering ViewPager switch when swiping left or right on WebView control on homepage document page
  • Fix Issue with file manager unable to recognize file extensions containing uppercase letters
  • Fix File manager may not automatically recognize project when first entering project directory
  • Fix Issue with file manager page unable to refresh automatically after deleting folder
  • Fix Issue with file manager sorting files and folders where ASCII initial letter names are put back
  • Fix FAILED ASSERTION exception in code editor debug function
  • Fix Issue with unable to debug again properly after closing editor during code editor debug process
  • Fix Issue with potentially omitting end characters when jumping to line end in code editor
  • Fix Issue with flickering screen when starting log activity page on main activity page
  • Fix Issue with packaged app unable to use opencc module properly
  • Improvement Click prompt experience for 'Unavailable ABI' control on package page
  • Improvement Supports using Shizuku to control 'Pointer Location' display switch
  • Improvement Supports using Shizuku to control 'Projection Media' and 'Modify Secure Settings' permission switches
  • Improvement Automator.gestureAsync/gesturesAsync supports callback function parameters
  • Improvement tasks module uses synchronous way for database operations to avoid potential data access inconsistencies
  • Improvement Script execution mode supports pipeline symbol separation mode parameters (e.g., starting with "ui|auto";)
  • Improvement Script execution mode supports single quotes and backticks and allows omitting semicolons (e.g., starting with 'ui'; or 'ui')
  • Improvement Script execution mode supports quick import of built-in extension modules such as axios, cheerio, and dayjs (e.g., starting with "axios";)
  • Improvement Script execution mode supports x or jsox mode parameters for quick enabling of JavaScript built-in object extension modules (e.g., starting with "x";)
  • Improvement img element src and path attributes support local relative paths (e.g., <img src="a.png" />)
  • Improvement Code editor supports intelligently determining insertion location when importing Java classes and package names
  • Improvement images module supports using paths directly as image parameters
  • Improvement importPackage supports string parameters
  • Improvement Server mode IP address supports clipboard import with intelligent recognition and smart conversion with space key
  • Improvement File manager supports default prefix selection when creating new files and automatically generates appropriate numeric suffix
  • Improvement File manager specifically informs on exception message when running project issue #268
  • Improvement File manager supports more types and displays corresponding icon symbols (supports over 800 file types)
  • Improvement Editable file types (jpg/doc/pdf, etc.) in file manager have added edit buttons
  • Improvement APK files in file manager support viewing basic information, Manifest information, and permissions list
  • Improvement Audio/video media files in file manager support viewing basic information and MediaInfo information
  • Improvement Package single file support auto-fill appropriate standardized package name and invalid character filter prompt
  • Improvement Package single file support automatically sets icon and auto-increments version number and version name based on installed same package name application
  • Improvement Package configuration file supports abis/libs option to specify default included ABI architecture and libraries
  • Improvement Support relevant message prompts when abis/libs options of package configuration file are invalid or unavailable
  • Improvement LeakCanary is excluded from official release version to avoid unnecessary growth
  • Improvement All English comments in project source code are accompanied by Simplified Chinese translations to enhance readability
  • Improvement README and CHANGELOG support multi-language (Automatically generated by script)
  • Improvement Enhance Gradle build script's version adaptability
  • Improvement Some dependency or local library version adjustments CHANGELOG.md
For more version history, refer to

Project Compilation and Build

For debugging or developing the AutoJs6 open-source project, you can use Android Studio (a product of Google) or IntelliJ IDEA (a product of Jetbrains).

This section introduces the compilation and build methods of the AutoJs6 open-source project using Android Studio as an example. IntelliJ IDEA is similar.

Android Studio Preparation

Download Android Studio Meerkat | 2024.3.1 Patch 1 version (choose one as needed):

Note: The release date for the above version is Mar 24, 2025. To download other versions, or if the above link is invalid, you can visit the Android Studio release archive page.

Install or extract the above file, then run the Android Studio software (e.g., "D:\android-studio\bin\studio64.exe").

Android SDK Preparation

Note: If the Android SDK is already installed on the computer system, this section can be skipped.

Use CTRL + ALT + S in Android Studio to open the settings page:

Appearance & Behavior -> 
System Settings -> 
Android SDK

If the Android SDK Location field is blank, click the Edit button on the right and click Next multiple times in the pop-up window.

Note: During the process, one or more relevant agreements may need to be accepted to continue.

Once the related resources are downloaded and installed, click the Finish button.
The Android SDK Location field above will auto-populate with the path, completing the SDK preparation work.

Android SDK Tools Preparation

AutoJs6 requires certain SDK tools (like NDK and CMake).

Note: If all required Android SDK Tools for AutoJs6 are already installed on the computer system, this section can be skipped.

Use CTRL + ALT + S in Android Studio to open the settings page:

Appearance & Behavior -> 
System Settings -> 
Android SDK -> 
SDK Tools (located in the right window)

Check Show Package Details, click NDK and CMake respectively to ensure the corresponding version tools are checked, the version information of the SDK tools is located in the version.properties file in the root directory of the AutoJs6 project.

JDK Preparation

The JDK (Java Development Kit) version required for the AutoJs6 project should be at least 17, but 19 or higher is recommended.

As of Apr 19, 2025, AutoJs6 supports up to version 24 of the JDK.

Note: If the JDK is already installed on the computer system and the version meets the above requirements, this section can be skipped.

JDK can be downloaded directly via the IDE or from the Oracle website.

Use CTRL + ALT + S in Android Studio to open the settings page:

Build, Execution, Deployment -> 
Build Tools -> 
Gradle

Gradle JDK can be chosen or added with different versions of JDK.

If a suitable version of the JDK (>= 17) already exists in the list, it can be selected directly.
Alternatively, you can choose Download JDK to download a suitable JDK, click the Download button and wait for the download to complete.
You can also choose Add JDK to add an existing local JDK, locating its directory and completing the JDK addition.

AutoJs6 Resources Cloning

Click Get from VCS button on the main page of Android Studio.
Fill URL field with https://github.com/SuperMonster003/AutoJs6.git,
The Directory field can be modified to a specific path if needed.
Click the Clone button, wait for the AutoJs6 project resources to be cloned to the local device.

Note: The above process may require the installation of Git.

AutoJs6 Project Building

After cloning, Android Studio will open the AutoJs6 project window and automatically complete the preliminary Dependencies download and Gradle build work.

Note: The above process may take a long time. If network conditions are poor, it may need to be retried multiple times (click the Retry button).

If the build couldn't proceed automatically or you need to rebuild the project, follow these steps:

  • From the Run/Debug Configurations menu in the Toolbar, select app, which is the main AutoJs6 application
  • Click the Build Project (hammer icon) button on the left to start building the project. The default shortcut is CTRL + F9
  • Wait for the build to complete. The Builder Output tab will display a message such as "BUILD SUCCESSFUL in 1h 17m 34s"

If the build fails, you can report the error message to the AutoJs6 project's Issues page.

Note: For more details on building and running the app, please refer to Android Docs

AutoJs6 Project Deployment (Run App)

Once the project is built successfully, it can be deployed as an application (App) to a physical device (e.g., phone/tablet) or a virtual device (e.g., Android emulator).

  • In the Toolbar, select app from the Run/Debug Configurations menu, which is the main AutoJs6 application
  • In the Available Devices dropdown on the right, choose the device on which the project app should run (physical or virtual)
  • Click the Run (triangle icon) button on the right to launch the app. The default shortcut is F10
  • Wait for the deployment to finish; the chosen device will automatically install and run the project app

AutoJs6 Project Deployment (Generate APK)

Package the project and generate an APK file that can be installed on Android devices:

  • Debug Version
    • Build -> Build Bundle(s) / APK(s) -> Build APK(s)
    • Generate signed debug APK
    • Path example: "D:\AutoJs6\app\build\outputs\apk\debug\"
  • Release Version
    • Build -> Generate Signed Bundle / APK
    • Select APK option
    • Prepare the signing file (create new or select existing), generate the signed release package
    • Path example: "D:\AutoJs6\app\release\"

Note: For more information on building an app for user release, please refer to Android Docs

Predefined Gradle Build Tasks for AutoJs6

Besides building the project App, AutoJs6 supports several predefined Gradle build tasks that help developers perform convenient project-related operations.

Under the Run/Debug Configurations menu in the Toolbar, you can find various predefined Gradle tasks, each indicated by an elephant icon on the left.

  • AutoJs6 [inrt:assemble]

Assemble the "inrt" build variant, which primarily serves the AutoJs6 script packaging feature.

The AutoJs6 project has various build variants. The "inrt" variant is used for packaging scripts, generating the template file "template.apk" required for packaging.

When using the packaging feature, you might encounter the following error message:

java.io.FileNotFoundException: template.apk

This indicates that the template file does not exist. You need to manually run the inrt:assemble task to generate the template file, then rebuild and redeploy the app.

Note: When the main project code changes and you want to synchronize these changes with the packaged app, you need to rerun the inrt:assemble task to generate the template files and redeploy the app

  • AutoJs6 [app:bundle]

Package the outputs of the debug build process, primarily for the AutoJs6 TypeScript definitions project.

After running the task, it produces the latest JAR file for the AutoJs6 project. Using the Android d.ts Generator (by NativeScript), you can generate the type definitions (d.ts format) for the main AutoJs6 app.

  • AutoJs6 [app:digest]

Append digest information to the APK produced by the release build, mainly to finalize the filename before publishing the latest version of AutoJs6 to GitHub.

Below is the comparison of filenames before and after appending the digest information:

Before:
autojs6-v6.6.2-arm64-v8a.apk
After:
autojs6-v6.6.2-arm64-v8a-0f2a9d74.apk

Reference: Android Docs

Script Development Assistance

To develop scripts that run with AutoJs6, appropriate development tools must be used:

For writing and debugging scripts on a PC, the VSCode plugin can enable PC-to-phone connectivity:

When writing code using development tools, code completion functionality can better assist developers in completing code:

When writing code, AutoJs6-related API and usage can be consulted in the documentation at any time:

Existing script development projects can serve as references and inspire creativity for personal script projects:

Contribution

Thank you to everyone who contributed to the AutoJs6 project development.

Contributors Number of Commits Recent Submissions
luckyloogn 3 2025/01/01
kvii 1 2024/10/16
chenguangming (Tom) 2 2024/05/14
LZX284 (AI) 17 2023/11/19
TonyJiangWJ 4 2023/10/31
little‑alei (抠脚本人) 12 2023/07/12
aiselp 6 2023/06/14
LYS86 (Lin) 2 2023/06/03

Data updated on Jan 1, 2025.

Data entries sorted in descending order by recent submissions.

Newly initiated, unprocessed Pull Requests will be included in the data statistics after merging.

Some contributors do not appear correctly in the GitHub Contributors due to empty contribution records, but their contribution records can still be viewed via Pull Request.

Reference in New Issue View Git Blame Copy Permalink