An avatar generator for the SugarCube 2 format of Twine.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
docs Rename readme.md to README.md Jan 18, 2019
src
.gitattributes
.gitignore
LICENSE
gulpfile.js
package-lock.json added site Jan 18, 2019
package.json v0.8.1 May 16, 2018

README.md

Noble avatars is a drop-in character portrait generator for the SugarCube 2 story format of Twine. It was built using resources that were generously open-sourced by Noble Master Games. All the code was written from the ground up in JavaScript to work with SugarCube.

Visit the homepage.
Live demo.

Downloads

Documentation

Features

  • Allows for player-controlled custom character creation out of the box, using a simple macro.
  • Portraits can be made clickable and used like <link>> macros for things like initiating conversations or seeing character descriptions.
  • Can be used to generate random and predefined character portraits for all your character-generating needs, using a simple, passage and macro-based API.
  • 15 trillion + combinations (supposedly, didn't do the math myself).
  • Includes a bevy of customization options and configuration settings.
  • A fairly complete JavaScript API and CSS selectors reference for tailoring the system to your needs.
  • Includes an optional preloader for the image assets to ensure good performance.
  • Simple to install and use.

Some things that aren't supported (at least right now).

  • This was designed to use SugarCube, so does not work as a general-use JavaScript library or Twine plug-in.
  • Using custom assets is possible but would requires some finagling to get it right. Making that less complex will be a design goal for the future, assuming this library sees some use and it is requested.
  • Unfortunately, Noble Avatars uses totally different assets for the base male and female options, meaning that gender selection is completely binary and required.
  • Right now, there's no way to tag certain creation options (outside gender restrictions and required-ness, i.e. all characters require eyes), meaning character portraits that are generated randomly are completely random by default, though you can use the API to supply only certain options to certain randomized characters, but this is labor-intensive.

Licensing info

This code is licensed under MIT. See the license for more. In general, you must provide attribution to me (Chapel) in addition to including the info from the credits section somewhere in your game, like an about page. It does not need to be particularly prominent. Please avoid implying that any of the individuals, myself included, directly worked on or endorsed your project.

Credits

Avatar graphics created by Noble Master Games
Avatar graphics designed by Mei-Li Nieuwland
Noble Avatar Graphics licensed under CC-BY-3.0