Adventure.js Docs Downloads

Score: 0 Moves: 0

Start Here

How To

Get Started
How to: Create a Game
How to: Create a Room
How to: Create a Player
How to: Create Assets
How to: Create an Exit
How to: Create a Lock & Key
How to: Set Descriptions
How to: Set Scores

Change the World
How to: Use Built-In Scenery
How to: Create Scenery
How to: Create Scene Events
How to: Create Zones

Change Settings
How to: Change Settings
How to: Use Disambiguation

Write Scripts
How to: Use Custom Templates
How to: Use Inline CSS
How to: Use String|Array|Function
How to: Use Custom Code
How to: Use Author Functions
How to: Use Custom Vars
How to: Customize Output
How to: Use Verb Subscriptions
How to: Use Verb Phase Hooks
How to: Use Verb Event Hooks
How to: Use Verb Effect Hooks
How to: Read Input
How to: Debugging

Use Tangibles
How to: Use Tangibles
How to: Use Aspects
How to: Use Linked Assets
How to: Use Collections
How to: Use Controllers
How to: Use Simple Vehicles
How to: Swing and Chasms

Use Substances
How to: Use Substances
How to: Use Substance Vessels
How to: Use Substance Emitters

Use Intangibles
How to: Use Intangibles

Use NPCs
How to: Use NPCs

Customize Verbs
How to: Verb Anatomy
How to: Verb Process
How to: Modify Verbs
How to: Write Verbs

Create a GUI
How to: About GUIs
How to: Create Custom CSS
How to: Create a Compass
How to: Create a Verb Dock
How to: Create an Inventory Dock
How to: Create an Image Dock

Go Off Road
How to: Write a Parser

Verbs
About Verbs

Composition
Verb: erase
Verb: read
Verb: type
Verb: write

Consumption
Verb: drink
Verb: eat
Verb: feed
Verb: lick

Conversation
Verb: ask_about
Verb: tell
Verb: think
Verb: yell

Destruction
Verb: aim
Verb: break
Verb: catch
Verb: cut
Verb: flick
Verb: hit
Verb: kick
Verb: kill
Verb: point
Verb: poke
Verb: punch
Verb: shine
Verb: slap
Verb: swing_at
Verb: tear
Verb: use

Direction
Verb: aft
Verb: down
Verb: east
Verb: enter
Verb: exit
Verb: fore
Verb: in
Verb: north
Verb: northeast
Verb: northwest
Verb: out
Verb: port
Verb: south
Verb: southeast
Verb: southwest
Verb: starboard
Verb: up
Verb: west

Examination
Verb: examine
Verb: look

Gesticulation
Verb: wave

Open & Shut
Verb: close
Verb: lock
Verb: open
Verb: pick
Verb: seal
Verb: unlock
Verb: unseal

Sensation
Verb: listen
Verb: smell
Verb: taste
Verb: touch

Utilization
Verb: again
Verb: brief
Verb: exits
Verb: inventory
Verb: locations
Verb: nothing
Verb: oops
Verb: restore
Verb: save
Verb: teleport
Verb: undo
Verb: verb_template
Verb: verbose
Verb: verbs
Verb: wait
Verb: where
Verb: xyzzy

Assets
About Assets

Base Classes
Class: Aspect
Class: Asset
Class: Intangible
Class: Matter
Class: State
Class: Substance
Class: Tangible
Class: Thing
Class: VerbSubscription

Bathroom
Class: Bathtub
Class: Faucet
Class: FaucetHandle
Class: Plug

Characters
Class: Character
Class: NPC
Class: Player

Clothing
Class: Clothing
Class: Scrunchy

Controls
Class: Button
Class: Control
Class: Dial
Class: Gauge
Class: Lever
Class: Switch

Doors & Apertures
Class: Aperture
Class: Door
Class: Exit
Class: Hole
Class: Manhole
Class: Window

Electronics
Class: Computer
Class: Keyboard
Class: Outlet
Class: Printer
Class: Radio
Class: Scanner
Class: Screen

Food and Drink

Forest
Class: Branch
Class: ExtrusionBranch
Class: Tree

Furniture
Class: Bed
Class: Chair
Class: Coathook
Class: Coatrack
Class: Desk
Class: Drawer
Class: Furniture
Class: Pedestal
Class: Table
Class: Tub

Glasses & Optical
Class: Binoculars
Class: EyeGlasses
Class: OpticalDevice
Class: StationaryTelescope
Class: Telescope

Global Assets

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

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

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

Class: global_ceiling
Class: global_floor

Kitchen
Class: Bowl
Class: DrinkingGlass
Class: DrinkingMug

Keys
Class: Key
Class: Lockpick
Class: SingleUseKey
Class: SingleUseLockpick
Class: SkeletonKey

Luggage
Class: Coinpurse
Class: Knapsack
Class: Luggage
Class: Purse

Private Library Assets
Class: All
Class: GlobalAsset
Class: GlobalNothing
Class: GlobalSomething
Class: GlobalString
Class: SubstanceEmitter
Class: Vessel

Room & Room Parts
Class: Ceiling
Class: Floor
Class: Room
Class: Wall

Scenery
Class: Collection
Class: Sky

Sports Equipment
Class: Bicycle
Class: Skateboard

Substances
Class: Gas
Class: Liquid
Class: Slurry
Class: Solid

Treasure
Class: Chalice
Class: Chest

Underground
Class: Stalactite

Vehicles

Weapons

Writing Materials
Class: Blackboard
Class: Chalk
Class: Eraser
Class: Marker
Class: Paper
Class: PaperMoney
Class: Pen
Class: PenCap
Class: Pencil
Class: Typewriter
Class: Whiteboard
Class: WritingImplement
Class: WritingSurface

Class: Candle
Class: Cap
Class: Climbable
Class: ClimbableVine
Class: Container
Class: Doll
Class: Drain
Class: Drainable
Class: Edible
Class: Electronics
Class: Extrusion
Class: FloorChasm
Class: GasContainer
Class: GraduatedController
Class: Ladder
Class: Lantern
Class: LiquidContainer
Class: Platform
Class: Potion
Class: Rideable
Class: Rope
Class: Scenery
Class: Sink
Class: SolidContainer
Class: Spell
Class: Staircase
Class: SurfaceContainer
Class: Zone

Framework Reference
About Adventurejs
Class: adventurejs
Class: Adam
Class: Assets
Class: Atom
Class: Dictionary
Class: Display
Class: Events
Class: Game
Class: Input
Class: LoginManager
Class: NounMustBe
Class: ParsedNoun
Class: Parser
Class: Phrase
Class: Reactor
Class: RestoreManager
Class: SaveManager
Class: Scorecard
Class: Settings
Class: SubstanceMixer
Class: UID
Class: UserManager
Class: Verb

Downloads
Example Games - TBD
FAQs
Roadmap
Troubleshooting - TBD
xyzzy

Document offering troubleshooting tips for Adventurejs.

troubleshooting

Troubleshooting

Documentation generated by JSDoc 3.6.11 on Mon Nov 20 2023 18:04:51 GMT-0800 (Pacific Standard Time)
Found a problem or error in the docs? Report it to docs@adventurejs.com.