Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

Ink Runner

Ink Runner is a browser-based platformer built with Phaser 3.
The game uses a hand-drawn notebook-paper style and includes 7 levels, enemy encounters, a boss arena, and late-game darkness/cave levels.

Quick Start

No build step is required.

  1. Open ink-runner/index.html in a browser, or serve the folder with a simple static server.
  2. If you are on a production hostname configured in PASSWORD_PROTECTED_HOSTS (ink-runner/index.html), enter the gate password when prompted: thaneiscool.
  3. Play.

Example local server:

cd ink-runner
python3 -m http.server 8000

Then open http://localhost:8000.

Controls

  • Move: Arrow Keys or WASD
  • Jump: Space or W / ArrowUp
  • Dash: Shift (hold to keep dashing)
  • Punch/Attack: F
  • Fireworks: P
  • Toggle darkness effect: K

Dev / Skip Shortcuts

  • Skip to Level 2: Z
  • Skip to Level 3: X
  • Skip to Level 4: C
  • Skip to Level 5: V
  • Skip to Level 6: B
  • Skip to Level 7: N
  • Skip back one level: M

Project Structure

  • ink-runner/index.html: Entry point, password gate, Phaser CDN include
  • ink-runner/main.js: Game logic, level construction, combat, boss encounter
  • ink-runner/style.css: Global styling and gate UI
  • ink-runner/img/: Paper background assets

Notes

  • The project currently loads Phaser from CDN (jsdelivr).
  • Most graphics are generated in code at runtime via Phaser graphics APIs.
  • Password gating is host-based: only hostnames listed in PASSWORD_PROTECTED_HOSTS require a password (good for Netlify production-only protection).
  • Local and preview bypasses are automatic (localhost, 127.0.0.1, file://, and Netlify preview URLs like deploy-preview-*--*.netlify.app).
  • You can force bypass with ?nogate=1 (for example, http://localhost:8000/?nogate=1).
  • In Level 7, activating Lightroots permanently lights nearby cave areas.
  • Background music is level-based and loops:
    • Levels 1-4: ink-runner/audio/Drift Away (Instrumental).mp4
    • Level 5+ (boss + cave): ink-runner/audio/Demons in the Machines.mp4

About

An AI-generated platformer

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages