cyrusfirheir / cycy-wrote-custom-macros

Macros for SugarCube 2.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cycy wrote custom macros


Installation

Download this repository (easiest way to grab everything, really) and cherry pick whatever you want in your project. Some might have CSS files, others won't, but everything you need is there. Along with a README.md for each macro which has further instructions on installation and usage.

Each macro set provides a <macro-name>.twee-config.yaml file which can also be added to workspace if using the Twee 3 Language Tools VSCode extension, for macro definitions of that set. It's recommended for error diagnostics.

Besides that, there's a cycy.twee-config.yaml in the root of the repo, and that has definitions for all the macro-sets in one file. This is the better way to go about it — only one file to keep track of.


Macro sets

  1. Click to Proceed (CTP) v2

    • Clean way to reveal text block-by-block in the same passage without having to nest a million <<linkreplace>> macros.
    • Primarily made for sequential rendering, e.g. VN like interfaces.

    NOTE: CTP v1 can be found here.

  2. Crossfade

    • Crossfade between two images with simple macros.
    • Can be used to fade-in/out too.
  3. Live Update

    • Make the display of an expression 'live' and 'update' every such display to see the changes instantly.
    • Under the hood, it works similarly to how the <<replace>> and other DOM macros do, but on the surface, it's wayyy simpler to use.

JavaScript Libraries

  1. Rock paper scissors (RPS)
    • Makes RPS logic simpler.
    • Works for more than just three elements.

About

Macros for SugarCube 2.

License:The Unlicense


Languages

Language:JavaScript 97.8%Language:CSS 2.2%