How to Run the game

READ CAREFULLY!!

make sure you have all the files on your computer with the same file structure as in this repo
remove all files within save_data/
remove/modify any file contents under the Dungeons/ folder (DO NOT change or remove anything in the Dungeons/world/ folder though, that stuff is important for the Engine to run (see dungeon building for help on safely modifying the game))
run Insert Dungeon Name Here.exe
If you have issues, there's an issues page on github, but to be fair, idk how it works, so yeah.
This Engine is still under development, don't expect much to work

tutorial (until I make an actual tutorial in-game)

once the game has fully loaded, type [0]: engine:new-player <id> <max_health> <name> note:
- <id> may not be 0
- <max_health> will eventually be removed once I find a good default (try 20 for now if you're unsure)
- <name> can contain spaces if surrounded by quotes (ex: "Example name idk")
this will create a new player (whaaAAA????)
now when you intend to type text as your player, start each message with [<player_id>]: (including the trailing space)
[0]: ... is reserved for running commands
more coming soon

Dungeon Building

Note: This is going to be a VERY long, detailed, guide to creating a dungeon and all it's components

Dungeon Script
Engine Code

Here's a handy tool to help you get started with dungeon building:
Dungeon Generation Tool

File Structure

Dungeons/
├─ <dungeon_id>/
│  ├─ resources/
│  │  ├─ ammo/
│  │  ├─ armor/
│  │  ├─ enemies/
│  │  ├─ items/
│  │  ├─ tools/
│  │  └─ weapons/
│  ├─ scripts/
│  │  ├─ rooms/
│  │  └─ <dungeon_id>/
│  ├─ rooms/
│  ├─ combats/
│  ├─ <dungeon_id>.json
│  └─ ec_functions.json
:

Dungeons

Base JSON values:

{
  "name": <text>,
  "version": <number>,
  "entry_point": <room identifier>,
  "events": {
    "on_enter": {engine code},
    "on_exit": {engine code}
  }
  "data": {
    "<name>": <value>|{boot engine code}
  }
}

More comming soon!

Rooms

{
  "name": <text>,
  "interactions": [
    // interactions will be explained below
  ],
  "events": {
    "on_enter": {engine code},
    "on_exit": {engine code},
    "on_input": {engine code}
  }
}

Interactions

for interactable types, go here.

Door Interaction JSON:

{
  "type": "engine:door",
  "id": <text>,
  "target": <room identifier>,
  "travel_message": <text>|{engine code},
  "lock_message": <text>|{engine code},
  "locked": <boolean>,
  "open_message": <text>|{engine code},
  "disengage_message": <text>|{engine code}
}

Weapons

WIP

Ammo

WIP

Armor

WIP

Items

{
  "parent": <item identifier>,
  "name": <text>|{boot engine code},
  "max_count": <int>,
  "count": <int>|{boot engine code},
  "data": {
    "<name>": {boot engine code}
  },
  "events": {
    "on_use": {engine code},
    "on_expended": {engine code}
  }
}

Tools

{
  "parent": <tool identifier>,
  "name": <text>|{boot engine code},
  "max_durability": <int>,
  "durability": <int>|{boot engine code},
  "data": {
    "<name>": {boot engine code}
  },
  "events": {
    "on_use": {engine code},
    "on_equip": {engine code},
    "on_unequip": {engine code},
    "on_damaged": {engine code},
    "on_break": {engine code}
  }
}

Status Effects

WIP

Enemies

WIP

Attacks

WIP

Entities

WIP

Interactable Types

WIP
see the door interactable type as an example

Combats

WIP

Engine Code

WIP

Engine Code is the scripting language used for events and operations within user-made dungeons.

note:
boot engine code is evaluated on dungeon load up. This means the functions you can use in it are limited
engine code is evaluated as needed during runtime, it is not evaluated on load up.

to use a dungeon script instead of writing engine code, reference the script with: {"#script": "path/to/script"} the path doesn't have to be absolute, nor does it require you to write the ds/dungeon_script extension in the file name, however, make sure the path cant be mistaken for another script file. (The compiler will look in every dungeon folder, until it finds something that matches the path)

ie: referencing scripts/rooms/room1/on_enter may match your_dungeon/scripts/rooms/room1/on_enter.ds or my_dungeon/script/rooms/room1/on_enter.ds so it is recommended that you have your dungeon namespace present in the path somewhere

westbot657 / DungeonEngine