LimeTree Engine CLI

A lightweight, terminal-based adventure game engine that uses ZIP archives as game files. Built for speed and simplicity.

1. Installation

Install the engine globally via npm to use the limetree command anywhere:

npm install -g limetree-engine

2. Usage & Commands

The CLI provides a straightforward interface to manage and play your adventures.

| Command | Description | Example | |----------------------|--------------------------------------------------|-------------------------------------| | limetree open | Loads a ZIP and starts the game from @start | limetree open "C:\mygame.zip" | | limetree --version | Displays the current version of the engine | limetree --version | | limetree --help | Shows all available commands and options | limetree --help |

3. Project Structure & Build Rules

LimeTree CLI is designed to parse your specific 'Build' folder logic.

Internal ZIP Layout

• Build/ (The main project container)
  • @start/ (The entry point)
    • !a.txt (Starting story and logic)
    • portal.yesss/ (Directory for a specific choice)
      • !ab.txt (Resulting story file)
    • portal.no/ (Directory for another choice)
      • !acd.txt (Resulting story file)

Logic Parsing (Build Mode)

The engine reads commands within your text files:

• self.label: The main text displayed to the user[cite: 1].
• create [button]: Defines interactive choices[cite: 1].
• self.button.text: The text displayed for a specific option[cite: 1].
• self.button.portal: The directory path to jump to after a choice[cite: 1].

4. How to Create Your First Game

1. Create a "Build" folder.
2. Inside "Build", create an "@start" folder with a "!a.txt" file[cite: 1].
3. Define your labels and buttons using the "self.button.portal" syntax[cite: 1].
4. For every portal, create a sub-folder (e.g., portal.yesss) with its own story file[cite: 3].
5. Compress the "Build" folder into a ".zip" archive.
6. Run: limetree open "yourfile.zip"

5. Technical Details

• Memory Efficient: Reads ZIP content directly into memory without extracting to disk.
• Platform Independent: Works on Windows, macOS, and Linux terminals.
• Path Mapping: Automatically resolves virtual paths like "@start/portal.yesss/!ab.txt" regardless of OS[cite: 3].

Developed by canuxs.