A collection of systems and macros for Twine.
Branch: master
Clone or download
ChapelR fixes to simple inventory
fixes #19
fixes #18

- Adds the inventory methods inv#isEmpty() and inv#count().
- Fixes minor inconsistency with inv#pickUp() and <<pickup>> macro behavior when used with unique keyword.
Latest commit 3195cd3 Feb 15, 2019

readme.md

Chapel's Custom Macro Collection

Documentation

Installation Guide

To install these macros, all you need is the code. It is highly recommended that you install the minified version (found in the scripts/minified/ directory), as these versions will have improved performance. You will only need the non-minified versions if you plan to edit the code in some way.

To install these macros, you will need to be using the most recent version of SugarCube 2 in most cases, and this is almost never the version that comes with Twine 2. See SugarCube's website for updating / installation instructions.

For Twine 2 users: copy and paste the required JavaScript code from this repo into your story JavaScript area. Some macros may also require CSS code, which goes in your story stylehseet.

For Twine 1, you'll need to copy and paste the JavaSCript portions into a script-tagged passage, and the CSS portions (if any) into a stylesheet-tagged passage. You can create new passages and add the tags yourself, or right-click on a blank spot in the editor and select new script here and new stylesheet here to generate each passage.

For Twee2, refer to its documentation for how to create the tagged passages you need.

For Tweego, simply place the code in .js and .css files as appropriate and include them in your directory / command line options just as you would any other code files.

Installation: Troubleshooting

If you're having issues, please try some of these solutions.

Before copying the script you want from GitHub, you can find a button above the code on the right called raw. Try using this code instead, as it takes you to a page with only the code allowing you to copy it and paste it much more easily, and preventing potential encoding issues.

Make sure you're using the latest version of SugarCube 2 and of your preferred compiler.

Make sure that any code above my scripts in your JavaScript is correct, particularly in ending with a semicolon and with regard to closed parens, quotation marks, brackets, braces, etc. Try testing without my code again to make sure you didn't overwrite a chunk of whatever code was already there, which is easy to do in the tiny boxes you get from the Twine apps.

If none of those common solutions help you with the problem, open an issue here on the repo. Be sure to tell me the exact version of SugarCube (found in the Change story format menu option in Twine 2) and the exact version of your compiler (for Twine 2, the bottom right on the story list).

Also try to screen grab or copy/paste any specific error messages.

General Troubleshooting

If a script doesn't seem to be working right, remember:

  • Everything is case-sensitive--<<message>> and <<MESSAGE>> are not going to point to the same macro.
  • Follow the instructions carefully. There are a few places where my macros break with traditional SugarCube things, like the orders of arguments and stuff. I'm trying to hew closer to SugarCube's standards moving forward, though.
  • Make sure you're using SugarCube 2, the most recent version you can. This is very rarely the same as the version packaged with Twine 2 or the other compilers.

If you're reasonably sure you've read the docs and are using the right version and such, feel free to open an issue.

I Need Help!

If you're having an issue with these macros and suspect that it's operator error rather than a bug, you can still open an issue, but a faster way to get help would be to post in one of these Twine communities:

Regardless of where you seek help, you'll want to provide links to the scripts you're using for your potential answerers. Don't expect people to know what "Chapel's fading macros" are or how they work just from the name.

You Don't Write Good...

Please take a minute and help me out by reporting any errors in the documentation via an issue, or pull request a fix if you've got the time and know-how. Both are greatly appreciated.

WAIT! WHERE'S THE X MACRO???????

Some macros were just too good for this world. Some turned out to be really bad ideas. Some were just so poorly written that they'll take a long time to reimplement. That said, if a macro you need / want / like isn't here, you can go here to download the original collection as it was in it's prime.

Credit and Attribution

This code is dedicated to the public domain. You don't need to provide credit, attribution, or anything else. You could even pass it off as your own! (Would be mean.)

If you do wish to credit me, you can credit me as Chapel, but please do not imply that I directly worked on your game.

If you have any questions or concerns about this, refer to the license.

Donations

Note: I suggest donating to Twine development or SugarCube development if you really want to help out, but I'd welcome a few dollars if you feel like it.

ko-fi

Fun stuff and details.


Ever wonder what the most popular macros here are?

I don't actually track usage data or anything, but according to pure traffic numbers, the top three are:

  1. The fading macro set.
  2. The simple inventory.
  3. The first macro.

It's been a little over a year (almost exactly 13 months, actually) between the very first public release of this repo on May 30, 2017 and the "official" v2 release on June 29, 2018. I started working on v2 in November of 2017, with the first public updates showing up late that month.

I started with Twine (in earnest, I had messed with it years ago in the Sugarcane days) in late November / early December of 2016, and knew nothing about programming, outside a True BASIC high school course, and less than nothing JavaScript / web development. I just want to encourage anyone who can't get through a function without a billion impossible to find syntax errors, or anyone who literally cannot comprehend MDN. It's more art than science, more writing a novel than doing your taxes.

And like writing a novel, you can get better at it if you're willing to suck at first. Be willing to suck. You will get there.