Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.56 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.56 KB

Build status

Welcome to the code repository for the egamebook project.

This repository contains all the moving parts needed for running egamebook campaigns, in one place, using the monorepo approach.

If you choose to play around with egamebook, you will probably spend most of your time in the edgehead/ subdirectory. Edgehead is the canonical example of an egamebook, and it provides a way of running the game in terminal. Go read Edgehead's README to learn more about playing, playtesting, and developing Edgehead.

If you're thinking of building your own egamebook, the easiest way to start is to make a copy of the edgehead subdirectory and start changing the text files and the Dart files there.

If you're looking for more info about egamebook itself, visit egamebook.com.

To play the IFCOMP 2017 entry called Insignificant Little Vermin, click here.

Development

Most development happens inside the subfolders of this monorepo. But for CI, you'll need to use the Dart mono_repo package:

dart pub global activate mono_repo

This installs the mono_repo command line tool.

To run all tests in the whole mono_repo (the tests that will be run by Github Actions), use this command:

mono_repo presubmit