Getting Started

Prerequisites

Before you begin, make sure you have the following installed:

Requirement	Version	Notes
Node.js	>= 18.0.0	Download
NPM	>= 9.0.0	Bundled with Node.js
Acode	Latest	Play Store

Termux Users

You can install Node.js directly inside Termux with:

pkg install nodejs

Installation (Highly Recommended)

We highly recommend installing the acodez CLI globally on your machine!

npm install -g @rvrugved/acodez

Why install it globally? By making it global, your entire Acode Plugin Portfolio is at your fingertips from anywhere on your machine. You can instantly check acodez earnings, read acodez reviews, or quickly scaffold a new plugin with acodez init without waiting for npx to repeatedly download packages. Plus, it keeps your local project folders much smaller!

Scaffolding a New Plugin

Run the following command anywhere to initialize a fresh TypeScript or JavaScript plugin:

acodez init my-plugin

The beautiful new terminal UI will guide you through the setup:

Welcome to AcodeZ!

[*] Plugin Name: My Awesome Plugin
[*] Plugin ID (e.g. com.example.plugin): com.yourname.myplugin
[*] Version: 1.0.0
[*] Author Name: Your Name
[*] Author Email (Optional):
[*] GitHub Username (Optional):
[*] License: MIT
[*] Enable Code Obfuscation? No

Once complete, acodez will:

1. Copy the unofficial template (created by Rugved) into your new directory
2. Inject all your details into plugin.json and package.json
3. Automatically run npm install for you.

Starting Development

Navigate into your project and start the dev server:

cd my-plugin
npm run dev

You will see:

AcodeZ v1.0.4 — Development Mode
  Esbuild watcher   → active
  HMR WebSocket     → ws://127.0.0.1:3001
  Plugin Server     → http://127.0.0.1:3000/plugin.zip

Loading the Plugin in Acode

1. Open Acode on your Android device
2. Go to Settings → Plugins → Add (+)
3. Select Remote Plugin URL
4. Enter: http://<YOUR_PC_IP>:3000/plugin.zip

Finding Your IP Address

On Linux/macOS, run ip addr or ifconfig.
On Windows, run ipconfig.
On Termux, run ip route — use the same 127.0.0.1 if coding directly on your phone.

Your plugin is now live inside Acode. Every time you save a .ts or .scss file, it will automatically hot-reload inside Acode in under a second.