ssube/textual-engine repository overview

⁠Textual Engine

This is a text adventure engine.

See the getting started docs⁠ for more info.

⁠Features

• text
• adventure
• world:
  • persistent rooms
  • wandering monsters
• engine:
  • event broadcast
  • entity scripts

⁠Contents

• Textual Engine⁠
  • Features⁠
  • Contents⁠
  • Building⁠
  • Running⁠
  • Docs⁠
  • License⁠

⁠Building

Some make targets are provided:

• make build: transpile Typescript sources
• make test: build and run mocha tests
• make cover: run make test with nyc code coverage

⁠Running

Some make targets are provided:

• make run: run with test world

⁠Docs

More detailed docs are located in ./docs⁠.

Available documentation includes:

• Engine Architecture⁠
• Development Workflow⁠
• Getting Started⁠
• Creating Worlds⁠

⁠License

This project uses the MIT license⁠.