Using the Documentation - ThePix/QuestJS GitHub Wiki

I am conscious that as Quest 6 gets more and more comprehensive, the documentation gets ever bigger - it is currently over a hundred pages - and consequently harder to navigate. I am not sure if there is a solution to this, but this page is to at least help authors find what they are looking for.

Note that I write documentation as I go along, so it is up-to-date with the latest GitHub upload, give or take a day (in fact it will occasionally be ahead of the upload). That means the most recent release version may be a little behind the documentation. I also have to acknowledge that some pages may still be on older versions; if, for example, a function has been modified, the documentation for the function will get updated at the time, but example code that uses the function on other pages may be missed (if you see that, let me know!).

You should be able to clone the help pages (i.e., make an offline copy), using this link. I have not tried it, but you probably need the Github Desktop installed. https://github.com/ThePix/QuestJS.wiki.git

If you get stuck, post you questions in the QuestKit forum (which will hopefully get re-named soon...) or create an issue on Github (looks somewhat left-top of this page).

Tutorial

If you are new here, I recommend following the tutorial. At the very least actually do the first page, as this is the starting point of any project, and read the other pages.

Search

There is a search facility, at the far left-top of every page. It searches the entirety of GitHub, but if you clck the text box some default text will appear, "repo:ThePix/QuestJS ". Keep that there, and type your search term after it, and it will just search this repository. It will then list the number of bits in each section. You want to click on "Wikis" to find pages in the documentation.

Sections

So how are pages split between the different sections?

Quest Basics: These pages are about the nuts and bolts of Quest 6, the infrastructure that is used by everything else. This is where the important attributes are listed, the basic functions.

Text Processor: The text processor takes a string with special codes embedded in it and converts it to output. This can be as simple as styling it a certain way, to changing the content, which could in turn depend on the character and item involved. You can create games without bothering with the text processor, but once you know how to use to it, it makes life much easier. For a lot of tasks, it avoids having to use anything but the most basic JavaScript.

Commands: Pages about how to create new commands are in this section.

Templates: Templates are how we give an item all the attributes it needs to be a certain type of thing. If you want your item to be a container, give it the CONTAINER template, if it can be switched on and off, give it the SWITCHABLE template. These are mostly listed in this section, the exceptions being those relating to NPCs and RPG games, which get their own section.

Handling NPCs: Anything relating to NPCs - characters other than the player - will be in this section.

The User Experience: The User Interface section is those topics that affect the display of the game, rather than the state of the game world. Setting a font, modifying the side pane, adding a map or image all change what the player sees, but have no impact on the game world. Sounds are also covered in this section.

Role-Playing Games: Anything relating specifically to role-playing games will be in this section.

Web Basics: This section has articles giving a quick overview of the technologies used in Quest 6; JavaScript, HTML, etc.

How-to: A number of guides about how to do a specific feature that do not fit else where.

Meta: Issues about the whole game, rather than a specific command, object or system.

Reference: Pages about Quest 6, but not about authoring, are here. This is mostly notes about the Quest 6 code itself, useful to anyone wanting to develop Quest 6 or know why it is written the way it is, as opposed to write games with it.

Do your part

Get in contact if you have suggests. Or if you find something hard to find, let me know where you expected it to be.