Skip to content

README.md

Latest commit

 

History

History
156 lines (116 loc) · 4.53 KB

README.md

File metadata and controls

156 lines (116 loc) · 4.53 KB

NeoTerm Documentation

Technical documentation for NeoTerm - A modern Android terminal emulator with Termux compatibility.

Quick Reference

Core Features

  • 115 Color Schemes - Verified count from app/src/main/assets/colors/
  • 28 Fonts - Verified count from app/src/main/assets/fonts/
  • ARM64-v8a Only - Single architecture support (app/build.gradle:70)
  • Termux Compatible - Full apt/pkg package management
  • Profile System - Save multiple terminal configurations
  • Adaptive Keyboard - HackersKeyboard with theme matching
  • Auto-update - GitHub release checker

System Requirements

  • Architecture: ARM64-v8a (aarch64) ONLY
  • Android: 5.0+ (Lollipop or newer)
  • Storage: ~100MB base installation
  • RAM: 512MB minimum, 1GB+ recommended

Installation

  1. Download APK from GitHub Releases
  2. Enable "Install from Unknown Sources"
  3. Install APK
  4. Launch and complete setup wizard
  5. Wait for asset download (required)

Package Management

Basic Commands

pkg update              # Update package lists
pkg install vim git     # Install packages
pkg search <name>       # Search packages
pkg uninstall <name>    # Remove packages

Notes

  • First package install is slower (path compatibility fixes applied)
  • Subsequent installs are faster
  • Most Termux packages work without modification

Customization

Color Schemes (115 total)

  1. Menu → Settings → Customize → Color Schemes
  2. Select theme
  3. Applies to all sessions without profiles

Fonts (28 total)

  1. Menu → Settings → Customize → Fonts
  2. Select font and adjust size
  3. Applies immediately

Profiles

  1. Menu → Settings → Profile Manager → Create Profile
  2. Configure: name, color scheme, font, shell, commands
  3. Create session with profile: Menu → New Session with Profile

Profile Behavior:

  • Sessions without profile = use global settings
  • Sessions with profile = use profile settings (override global)
  • Global changes update only non-profile sessions

Sessions

Creating

  • New Session: Menu → New Session (global settings)
  • With Profile: Menu → New Session with Profile
  • System Shell: Menu → New System Session (/system/bin/sh)

Switching

  • Tap tab switcher button
  • Select from list
  • Note: Swipe gestures NOT supported

Closing

  • Auto-close when process exits with code 0
  • Manual: Long-press in tab switcher → Remove
  • From terminal: type exit

Features

Terminal

  • Multiple sessions
  • Auto-close on success (exit code 0)
  • Advanced text selection with scrolling
  • Extra keys row (ESC, TAB, CTRL, ALT, arrows)
  • Fullscreen mode
  • Keep screen on / Wake lock

UI

  • Material Design
  • Theme-aware status bar and toolbar
  • Tab-based session management
  • Context menus

Keyboard

  • HackersKeyboard integration (must enable in Android settings)
  • Adaptive theming (CustomKeyboardHelper.kt:98)
  • Optional system keyboard support

Configuration

File Locations

  • Profiles: ~/.config/neoterm/profiles/
  • Built-in Assets: /data/data/io.neoterm/files/

File Formats

  • Color schemes: NeoLang (.nl)
  • Profiles: NeoLang (.nl)
  • Fonts: TrueType (.ttf)

Documentation Pages

Customization Guides

Reference

  • FAQ - Frequently asked questions with detailed answers
  • Keyboard Shortcuts - Terminal and application keyboard controls

Building

Quick FAQ

Q: Why only ARM64? A: Build configured for ARM64-v8a for modern device optimization.

Q: Do all Termux packages work? A: Most work. Compatibility fixes applied during installation.

Q: Can I use alongside Termux? A: Yes, separate environments. Packages not shared.

Q: How to report bugs? A: GitHub Issues with device info, steps to reproduce, screenshots.

Contributing

See main README.md.

License

GNU General Public License v3.0 (GPLv3)

Repository: https://github.com/9hm2/NeoTerm Documentation: Technical reference based on verified codebase implementation