Skip to content

broomburgo/SimpleGame

Repository files navigation

SimpleGame

This is a companion Swift package to Narratore, and its purpose is to show some examples of its usage.

You can try out the example story by running the SimpleGame executable target.

Please refer to the main Narratore README for a more in-depth description of the content of this package.

Using this code in your projects

The main purpose of this Swift package is to document Narratore features. Nevertheless, most of the code can be used in your project, in order to start playing around with Narratore with minimal setup. In particular, 3 targets of this package can be incorporated in your projects:

  • SimpleHandler: contains a generic implementation of the Handler protocol, that allows to running a story in the command line, and persists the state of the game in a .json file, while also providing a function to restore the persisted state, if available (check out the SimpleGame executable implementation for an example of SimpleHandler usage);
  • SimpleSetting: a pretty basic, but flexible, generic setting for a Narratore story;
  • AdvancedSetting: based on SimpleSetting, enhances it with a more sophisticated World definition, and a localizable Message.

This Swift package will not be versioned, and can change over time to reflect changes in Narratore, so I advice against linking it directly: simply grab the code that you find useful in your projects, and use it as you see fit 😉.

About

A companion package to Narratore

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages