Go to file
Alexander Yakovlev d5a318cb26
Updated jquery version
2018-03-13 06:05:26 +00:00
lib Export processClick, removed HTML API 2015-12-29 08:45:18 +07:00
test Changed scrolling test 2015-10-20 23:36:21 -02:00
.gitignore Scroll to new content when switching panes in mobile mode 2015-05-06 14:56:20 -03:00
CHANGES.md Revert "Make file extensions consistent." 2015-10-14 09:40:31 -03:00
CREDITS Add Nafanin to CREDITS. 2014-07-25 09:33:02 +01:00
LICENSE Added clarification to the README that the license covers everything. 2013-12-10 09:31:29 +00:00
README.md Mention Jumbo Grove 2017-12-17 17:49:37 -08:00
package.json Updated jquery version 2018-03-13 06:05:26 +00:00

README.md

Undum (npm package)

2017 update: If you are here and you need this… I recommend you to look at Salet or Jumbo Grove instead. They are Undum-derived engines rewritten for extendability, packaged for NPM. They have all the features from here and more.

Undum is a general game framework for building a sophisticated form of hypertext interactive fiction.

Undum is a pure client-side library, HTML and Javascript. It is compatible with pretty much every modern web browser.

How is this repo different

Well, for starters, this is not a framework with docs and stuff here, this is a npm package. That way it's suitable for use with Raconteur.

Second, it's filled with custom modifications for my liking, such as:

  • Animations are faster
  • Got rid of animateQuality because I would never, ever use it
  • Got rid of loadHTMLSituations, same reason
  • Undum now exports processClick function - you can do custom interface with that!
  • Situation cannot be an implicit choice of itself.
  • Implicit choice optionText can be a piece of HTML, it's not escaped as text now. You can use text inputs!

License

The code, documentation, styles, design and images are all distributed under the MIT license. This permits you to modify and use them, even for commercial use. A copy of the MIT license is found in the LICENSE file.