Skip to content
cleoniPublic

Latest commit

 

History

188 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DimensioneY (DimY) Multiplayer Game Engine

Modern PHP 8 multiplayer virtual world and interactive adventure game engine, ported from an old project named DimensioneX. In this PHP software, code-named DimensioneY, we will make changes with respect to the original DimensioneX. DimensioneY should be able to load old files designed to run on DimensioneX, and keep its behaviour, up to a certain extent.


Architecture & Specifications Documentation

Comprehensive technical documentation and formal specifications reside in the docs/ directory:

  • docs/DXW_SPECIFICATION.md — Official DimensioneX World Definition (.DXW) Language Specification derived from the Developer's Reference (pp. 37–70). Covers all sections (WORLD, GUI, ROOMS, LINKS, CHARACTERS, ITEMS, SETS, SCRIPTS), control panels, attribute semantics, physical simulation, image show modes, and EBNF grammar.
  • docs/SMALLBASIC.md — Definitive SmallBasic Language Reference. Covers types, operators, statements, event model ($OWNER, $AGENT, $TARGET, $WORLD), and the complete catalog of all 55 built-in functions.
  • docs/COMMANDS.md — Game Engine Command Specification & API Reference. Details all core commands (click, go, rotate, look, use, use2, open, close, pick, drop, search, hide, put, give, enter, exit, say, save, login, logout), event bindings, parameter handling, and custom panel buttons.
  • docs/SKINS.md — Skins (.dxs) Specification. Covers directive rules, media directories, and skin attribute reference.
  • docs/UIBOT.md — UIbot API & Client Specification. Formal REST/JSON protocol reference and implementation blueprint for AI agents and automated/interactive clients.
  • docs/PLAY-AS-BOT.md — Bot & AI Player API Guide. Instructions for connecting external scripts or AI agents to the multiplayer engine via the UIbot JSON interface.
  • docs/CLASS_HIERARCHY.md — Class hierarchy of DimensioneY (this PHP implementation), same structure as the DimX one for comparison.
  • tools/notepadpp-syntax-highlighter/ — Notepad++ Syntax Highlighters (UDL 2.1) for .dxw and .dxs world definition and skin files with SmallBasic code folding, keyword, event, and function styling (light and dark mode). See instructions.
  • docs/dxw-examples/ — Reference .dxw world definition files:
    • world1.dxw — Minimal introductory world
    • world2.dxw — Minimal adventure with linked rooms, 1 character, events
    • world3net.dxw — The Beach (full multiplayer environment with multi-directional views)
    • demoturnbased.dxw — Minimal turn-based game implemented entirely in DXW / SmallBasic
    • fourinline.dxw — Turn-based board game implemented entirely in DXW / SmallBasic

Historical DimensioneX Specifications

These files describe the original DimensioneX (Java) project, NOT DimensioneY. They are kept as historical reference for behaviour and class mapping. What they describe may be unimplemented, implemented differently, or intentionally dropped in DimensioneY (e.g. Cluster, Dict/DictSorted). For the PHP implementation see docs/CLASS_HIERARCHY.md.

  • docs/DIMX_CLASS_HIERARCHY.md — Class hierarchy of the original DimensioneX (Java) project: mapping, Mermaid diagrams, subsystem breakdowns, and catalog of all 46 core engine classes.
  • docs/uml_explorer.html — Standalone, interactive HTML UML explorer with dynamic search, subsystem filters, and class inspector.
  • docs/uml_specifications.puml — Full PlantUML source code for rendering in PlantUML or IDE UML tools.

Implementation Principles & Type Handling

  • Loose Scalar Typing: In accordance with the DimensioneX design and PHP idiomatic behavior, no scalar values in the game are strictly typed. Attributes and properties (int, bool, string, float) are evaluated and coerced dynamically based on runtime context (e.g., open=0 coerces cleanly to boolean false, pickable or pickable=1 to boolean true, and numbers to their appropriate integer or string representations).
  • Responsive Web UI (UIhtml): Fully responsive web interface adapting automatically to any browser viewport, desktop screen, or mobile device without requiring manual screen size dropdowns or URL parameters. Features automatic landscape (desktop) and portrait (mobile *, 35%, 15%) orientation layouts, dynamic scene scaling, and dismissed message queues.
  • Native Data Structures: Java Dict / DictSorted collections are represented via native PHP associative arrays with case-insensitive property lookup.
  • Persistent State: Managed by Dimx\PersistenceManager with MySQL (PDO) support and transparent JSON file-based fallback.

PHP Engine Quick Start

The PHP engine resides in php/:

# Direct access via Apache/XAMPP:
http://localhost/dimya/php/

# Or via PHP built-in server:
cd php
php -S localhost:8000
  • Game Client: http://localhost:8000/ or http://localhost:8000/multiplayer.php
  • Maintenance Console: http://localhost:8000/maint.php
  • Configuration: php/config.php (template in php/config.sample.php — configures db, adminPasswd, serverType ['public' default or 'local'], world_file, tickLength [default 30s], msgRefreshRate [default 5s for #msgs refresh in UIhtml], base_url, and testBots)

Releases

Contributors

Languages