Skip to content

Commit

Permalink
docs cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
ChapelR committed Jan 27, 2020
1 parent 81d9d78 commit dd0dc32
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
31 changes: 15 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# Chapel's Unofficial Custom Macro API for Harlowe
# Chapel's Unofficial Custom Macro Framework for Harlowe

> Looking for macros to actually use? Look [over here](examples/main).
This code adds (more accurately recreates) a macro API to Harlowe to allow users to create and distribute custom macros. Place the contents of `macro.min.js` into your story JavaScript and use the API as described below to create macros. Generally speaking, the code of `macro.min.js` should be the first thing in your JavaScript section in Twine 2, or the first JS file compiled by your compiler.
This code adds (more accurately recreates) a macro API for Harlowe to allow users to create and distribute custom macros. Download [the latest release](https://github.com/ChapelR/harlowe-macro-api/releases) and place the contents of `macro.js` into your story JavaScript and use the framework as described below to create macros. Generally speaking, this code should be the first thing in your JavaScript section in Twine 2, or the first JS file compiled by your compiler.

This is unofficial code, and relies on hacks. Future versions of Harlowe may break it at any time. Intended for Harlowe 3. May work in Harlowe 1 or 2, but bugs or issues in those versions of Harlowe **will not be fixed**.

This documentation is intended for people who *make* custom macros, so it may be a bit technical. If you were sent here by some script written by some author and can't figure out what to do, go [here](installation-guide.md). It is recommended that macro creators similarly point their end users to the installation guide linked above rather than to this README or the repo in general.

See some example scripts [here](https://github.com/ChapelR/harlowe-macro-api/tree/master/examples).
If you are looking for custom macros you can use, [install the framework](installation-guide.md) and then check out the [macros page](examples/main).

Find releases on [the releases page](https://github.com/ChapelR/harlowe-macro-api/releases) and report issues on the [issues page](https://github.com/ChapelR/harlowe-macro-api/issues).
See some example scripts [here](https://github.com/ChapelR/harlowe-macro-api/tree/master/examples).

## Contents

- [Installation Guide](installation-guide.md)

- Documentation
- [Macro Collection](examples/main)
- Framework Documentation

- [Macro API](#macro-api)

Expand All @@ -29,22 +27,23 @@ Find releases on [the releases page](https://github.com/ChapelR/harlowe-macro-ap
- [Other APIs](#other-apis)

- [Function: `Harlowe.passage()`](#function-harlowe.passage)
- [Function: `Harlowe.tags()`](#function-harlowe.tags)

- [Function: `Harlowe.tags()`](#function-harlowe.tags)

- [Function: `Harlowe.goto()`](#function-harlowe.goto)
- [Function: `Harlowe.variable()`](#function-harlowe.variable)

- [Function: `Harlowe.variable()`](#function-harlowe.variable)

- [Function: `Harlowe.visited()`](#function-harlowe.visited)
- [Function: `Harlowe.hasVisited()`](#function-harlowe.hasvisited)
- [Function: `Harlowe.hasVisited()`](#function-harlowe.hasvisited)
- [Function: `Harlowe.turns()`](#function-harlowe.turns)

- [API_ACCESS](#api_access)

- [Unsolicited Advice for Macro Creators](#unsolicited-advice-for-macro-creators)

- [Examples](https://github.com/ChapelR/harlowe-macro-api/tree/master/examples)

- [Releases and Downloads](https://github.com/ChapelR/harlowe-macro-api/releases)

- [Issue Tracker](https://github.com/ChapelR/harlowe-macro-api/issues)
- [Release Notes](https://twinelab.net/blog/tags/harlowe-macros/)

## Macro API

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/main.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Macros

The following are some example macros created by me for this API. They're intended as both examples and as fully usable macros in their own right.
The following are some example macros created by me using this framework. They're intended as both examples and as fully usable macros in their own right.

## Documentation

Expand All @@ -13,4 +13,4 @@ The following are some example macros created by me for this API. They're intend

## Installation

[Install the custom macro API](/installation-guide) then install the macro scripts in the same manor. The macros must be *after* the main macro API script. Some macros may also require additional CSS, which should be installed in your story Stylesheet section. The individual documentation pages will have links to the minified and pretty scripts (and CSS, as appropriate). The minified versions will have improved performance and are recommended for most users.
[Install the custom macro framework](/installation-guide) then install the macro scripts in the same manor. The macros must be *after* the main macro API script. Some macros may also require additional CSS, which should be installed in your story Stylesheet section. The individual documentation pages will have links to the minified and pretty scripts (and CSS, as appropriate). The minified versions will have improved performance and are recommended for most users.
3 changes: 2 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="An unofficial custom macro framework for Twine2/Harlowe.">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
<style>body{font-size:16px;}.markdown-section a{color:#B10DC9;text-decoration:none;font-weight:bold;}.app-nav a.active,.app-nav a:hover{color:#B10DC9;}.app-nav a.active{border-bottom: 2px solid #B10DC9;}.content{margin:1rem;}.github-corner svg{fill:#111;}</style>
</head>
<body>
<div id="app"></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/installation-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation Guide

This is a guide for installing the custom macro API. The custom macro API itself does **not** include any custom macros, it is instead a resource to allow for the creation of custom macros. If you want to create your own custom macros, refer to the [documentation](README.md).
This is a guide for installing the custom macro framework. The custom macro framework itself does **not** include any custom macros, it is instead a resource to allow for the creation of custom macros. If you want to create your own custom macros, refer to the [documentation](README.md).

## Step 1: Get the Code

Expand Down

0 comments on commit dd0dc32

Please sign in to comment.