AdventureJS Docs Downloads

Score: 0 Moves: 0

Welcome

Getting Started
Create a Game
Create a Player
Create a Room
Create an Exit
Create a Door
Create a Key
Create a Puzzle
Add Some Treasure
Set Scores
Debug

Assets
Overview

Characters
About Characters
Players
NPCs

Intangibles
About Intangibles

Substances
About Substances
Substance Vessels
Substance Emitters

Tangibles
About Tangibles
Aspects
Collections
Components
Controllers
Swing and Chasms
Simple Vehicles

Descriptions
Overview
Default Descriptions
Description Modifiers
Exit Descriptions
Advanced Modifiers

Scenery
Overview
Scene Events
Zones
Global Scenery

Basic Scripting
Overview
Customize Output
Custom Templates
Inline CSS
Custom Code
Author Functions
Custom Vars
String|Array|Function
Events
Read Input
Scorecard
NPCs

Advanced Scripting
Custom Classes
Custom Parsers

Basic Verb Use
Overview
Verb Subscriptions
Verb Hooks
↳ Phase Hooks
↳ Action Hooks
↳ Reaction Hooks

Advanced Verb Use
Verb Anatomy
Verb Process
Modifying Verbs
Writing Verbs

GUI Options
Overview
Display CSS
Compasses
Verb Docks
Inventory Docks
Image Docks

Settings
Overview
Disambiguation

Example Games
Overview
How to Play
Chalice Dungeon
Writing Demo
Plumbing Demo
Plug Demo
Open Demo
GUI Open Demo

Asset Reference
Overview

__Base Classes
Overview
Aspect
Asset
GlobalConcept
Intangible
Matter
Nest
Substance
SubstanceEmitter
SubstanceMixer
Tangible
Thing
Vessel
Zone

__Framework Classes
All
GlobalAsset
GlobalDrawing
GlobalHour
GlobalMinute
GlobalNothing
GlobalNumber
GlobalSomething
GlobalString
GlobalTurn
Null
Void

__State Classes
Overview
Aperture_Is
Asset_Can
Asset_Is
Asset_Must
Character_Can
Character_Is
Character_Must
Drainable_Is
Exit_Is
GraduatedController_Is
Player_Can
Substance_Is
SubstanceEmitter_Is
Tangible_Can
Tangible_Is
Tangible_Must

Characters
Character
NPC
Player

Climbing
Climbable
ClimbableVine
Extrusion
Ladder
Staircase

Clothing
Clothing
Scrunchy

Containers
Container
GasContainer
LiquidContainer
SolidContainer
SurfaceContainer

Controls
Button
Control
Dial
Gauge
GraduatedController
Lever
Switch

Doors & Apertures
Aperture
Door
Exit
Hole
Manhole
Window

Electronics
Computer
Electronics
Keyboard
Outlet
Phone
Printer
Radio
Scanner
Screen

Food and Drink
Cherries
Edible
Grapes
Potable
Potion

Forest
Branch
ExtrusionBranch
Tree

Furniture
Bed
Chair
Coathook
Coatrack
Desk
Drawer
Furniture
Pedestal
Schmack
Table
Tub

Garage
Rope

Glasses & Optical
Binoculars
EyeGlasses
OpticalDevice
StationaryTelescope
Telescope

Global Assets

Global Exits
global_aft
global_down
global_east
global_fore
global_in
global_north
global_northeast
global_northwest
global_out
global_port
global_south
global_southeast
global_southwest
global_starboard
global_up
global_west

Global Scenery
global_air
global_clouds
global_hole
global_lightning
global_moon
global_mountain
global_mountains
global_rain
global_sky
global_sound
global_stars
global_sun
global_thunder
global_trees
global_wind

Global Walls
global_aft_wall
global_east_wall
global_fore_wall
global_north_wall
global_northeast_wall
global_northwest_wall
global_port_wall
global_south_wall
global_southeast_wall
global_southwest_wall
global_starboard_wall
global_west_wall

global_ceiling
global_floor

Intangibles
Information

Junk Drawer

Kitchen
Bowl
DrinkingGlass
DrinkingMug
Pitcher

Keys
Key
Lockpick
SingleUseKey
SingleUseLockpick
SkeletonKey

Luggage
Coinpurse
Knapsack
Luggage
Purse

Lighting
Candle
Lantern

Money
PaperMoney

Plumbing
Bathtub
Drain
Drainable
Faucet
FaucetHandle
Plug
Sink

Reservoirs
Desert
Lake
Reservoir

Room & Room Parts
Ceiling
Floor
FloorChasm
Platform
Room
Wall

Scenery
Collection
Scenery
Sky

Spells
Spell

Sports Equipment

Substances
Gas
Liquid
Slurry
Solid

Toys
Doll

Tools
Handtool
Screwdriver
Shovel

Treasure
Chalice
Chest

Underground
Stalactite

Vehicles
Bicycle
Skateboard
Vehicle

Weapons

Writing Materials
Blackboard
BlackboardEraser
Cap
Chalk
Crayon
Eraser
Marker
Paper
Pen
PenCap
Pencil
Typewriter
Whiteboard
WhiteboardEraser
WhiteboardMarker
WritingImplement
WritingSurface

Verb Reference
Overview

Altercation
hit
kick
kill
punch
rochambeau
slap

Composition
draw
erase
read
type
write

Consumption
drink
eat
feed

Conversation
ask
say
show
tell
yell

Destruction
break
cut
dig
flick
poke
squeeze
stomp
tear

Direction
aft
backward
down
east
enter
exit
fore
forward
in
left
north
northeast
northwest
out
port
right
south
southeast
southwest
starboard
up
west

Function
again
brief
exits
get
hide
inventory
knock
locations
nothing
oops
quiet
quit
restore
save
teleport
test
undo
unquiet
verb_template
verbose
verbs
wait
where
xyzzy

Gesticulation
aim
point
tap
wave

Introversion
recall
sleep

Locomotion
climb
crawl
descend
dismount
drive
float
fly
go
goTo
hop
hover
jump
peddle
ride
run
skate
slither
step
swim
walk
wear

Open & Shut
close
lock
open
pick
seal
unlock
unseal

Position
hang
kneel
lie
sit
stand

Restoration
fix
revive

Sensation
examine
feel
lick
listen
look
smell
taste

~Deprecation

Framework Reference
Overview
adventurejs
Atom
Dictionary
Display
Game
Input
LoginManager
NounMustBe
ParsedNoun
Parser
Phrase
Reactor
RestoreManager
SaveManager
Scorecard
Settings
StateManager
UID
UserManager
Verb
VerbSubscription

Downloads
Frequently Asked Questions
How to Play Text Games
License
Links
Made by Humans
Roadmap
Score
Troubleshooting
It Seemed to Make Sense at the Time
xyzzy

Tutorial explaining how to use custom code in AdventureJS.

tutorial, custom code

Basic Scripting:Custom Code

To be written...

Links License Roadmap xyzzy

Documentation generated by JSDoc 3.6.11 on Fri Sep 26 2025 11:28:52 GMT-0700 (Pacific Daylight Time)
Found a problem or error in the docs? Report it to docs@adventurejs.com.
© 2025 Ivan Cockrum. Licensed under MIT.