PHPackages                             johnsquibb/adventure-game-framework - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. johnsquibb/adventure-game-framework

AbandonedArchivedProject

johnsquibb/adventure-game-framework
===================================

A PHP framework for console text adventure games.

0.2.1-alpha(4y ago)412MITPHP

Since Jun 19Pushed 4y ago2 watchersCompare

[ Source](https://github.com/johnsquibb/adventure-game-framework)[ Packagist](https://packagist.org/packages/johnsquibb/adventure-game-framework)[ RSS](/packages/johnsquibb-adventure-game-framework/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (4)Used By (0)

adventure-game-framework
========================

[](#adventure-game-framework)

A PHP framework for console text adventure games.

Build and play games that use text commands such as:

```
> go north

> look inside the chest

> take key from chest

> unlock the cellar door

> turn flashlight on

```

Installation
------------

[](#installation)

Run `composer install` from the project directory.

Unit Tests
----------

[](#unit-tests)

A suite of PHPUnit tests is located in the [test directory](test).

Run the unit tests: `composer test`

Architecture
------------

[](#architecture)

The [Game Execution](docs/Game%20Execution.png) diagram shows how the framework components interact during a game run. The example game's [main.php](examples/demo-game/main.php) demonstrates how a game can be set up and run.

Examples
--------

[](#examples)

### Demo Game

[](#demo-game)

The [examples directory](examples/demo-game) contains a game that demonstrates the framework abilities. Run the game on the command line using:

`composer example`

In the same directory is a [diagram](examples/demo-game/docs/Example%20Game%20Map.png) showing the layout of the demo game.

### Automated Testing

[](#automated-testing)

A test client can be used to run automated tests.

Run the example:

`composer example-test`

The test client will play the game by running each of the test cases in the provided order. The client reports any errors, halting game execution. See [test.php](examples/demo-game/test.php) for more details.

Optionally specify the number of milliseconds to wait between each test, for example: `composer example-test 100` to wait 100 milliseconds between each test. The default wait value is 1000 milliseconds.

TODO
----

[](#todo)

- Basic Logging - errors, warnings, etc.
- Stats tracking - number of moves, number of visits to location, number of item uses, etc.
- Improve save/load system to allow for multiple files using choice system.

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~10 days

Total

3

Last Release

1765d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d29f1f427d17e1518100f4d208e5a601ecdad93f577b0ad2f4c248108765c335?d=identicon)[johnsquibb](/maintainers/johnsquibb)

---

Top Contributors

[![johnsquibb](https://avatars.githubusercontent.com/u/1144045?v=4)](https://github.com/johnsquibb "johnsquibb (4 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/johnsquibb-adventure-game-framework/health.svg)

```
[![Health](https://phpackages.com/badges/johnsquibb-adventure-game-framework/health.svg)](https://phpackages.com/packages/johnsquibb-adventure-game-framework)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)