Skip to content

soracompagnie/airaga

Airaga

An opinionated text game framework written in TypeScript.
Build immersive, interactive fiction with ease.

✨ Features

  • 🔧 Scene-based structure for organized storytelling
  • ⚡ Built with TypeScript for type safety and developer experience
  • 🧱 Opinionated architecture to reduce boilerplate
  • 🛠️ CLI to scaffold new games quickly
  • 🧪 Built-in test support with Vitest

🚀 Getting Started

1. Create a New Project

npx airaga new my-text-game
cd my-text-game
npm install

2. Start Writing

Edit scenes inside the src/scene/ folder. Your entry point is src\start.arg.

3. Run the Game

npm run start

Coming soon: a CLI runner for launching games directly!

📦 Project Structure

my-text-game/
├── public/           # Static assets
├── src/
│   ├── items/        # Game items and objects
│   ├── scene/        # Game scenes
│   └── start.arg     # Entry scene
├── .gitignore
├── airaga.config.ts
├── package.json
└── README.md

🧪 Tech Stack

📄 License

MIT License.

Created with ❤️ by Rafi Abiyyu Airlangga.

📢 Acknowledgements

Inspired by classic text-based games and modern tooling. Thanks to all open-source contributors!

About

Airaga is an opinionated text game framework written in TypeScript.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors