Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kksgandhi committed Aug 5, 2021
1 parent 6cfce1d commit 82931b6
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,21 @@ If you don't have any coding experience, this should still be easy to use.

If you have a lot of coding expertise, the fact that this is written in raw javascript means that it should be flexible and extensible, though depending on your need [Twine](https://twinery.org/) might still be better.

Beginner's Guide & Engine Demo
------------------------------

Instructions for those who just want to check out the project, or don't have much coding skill.
Demo Game
---------

Go to the releases section on the right, download `release.zip` from the latest release, unzip it, and open `index.html` to see the demo game.

- Check out `configuration.js` for a variety of game settings and simple tweaks.
- You can change the colors for the various speakers in `speakers.css`
- To actually write your own text, open `passages.js`. There is some commenting within the file that should hopefully help you along. The first two passages are examples of the simple features, after that the passages show off some of the advanced features.
Guide for Beginners
-------------------

Instructions for those who want to use micrologue to make their own game, but don't have much coding skill.

Download `release.zip` and unzip it. To make your own game, you should edit `configuration.js`, `speakers.css`, and `passages.js`. When you've made the edits you want, open `index.html` to see your game in action.

- `configuration.js` has a variety of game settings and simple tweaks.
- `speakers.css` allows you to change the colors for the various speakers.
- `passages.js` lets you write the actual passages that go into your game. There is some commenting within the file that should hopefully help you along. The first two passages are examples of the simple features, after that the passages show off some of the advanced features.

Advanced Guide
--------------
Expand Down

0 comments on commit 82931b6

Please sign in to comment.