Protocol-Escape Game

A Modular VR Escape Game

---

About the Game

Protocol-Escape Game is a virtual reality (VR) escape room game built using the LÖVR framework and Lua scripting. As an indie developer, I, Axlfc, designed this game to provide an immersive and extensible VR experience, packed with intriguing puzzles and a modular architecture for scalability.

---

Architecture

The game's architecture is organized into several components:

1. Core
   • main.lua: Entry point managing the game lifecycle.
2. Controllers
   • sceneManager.lua: Handles scenes and transitions.
   • gameController.lua: Manages game logic and player actions.
3. Models
   • gameState.lua, playerState.lua: Track game and player states.
4. Views
   • menuView.lua, hud.lua: Render UI and HUD components.
5. Entities
   • pawn.lua, character.lua: Represent objects and players in the game.
6. Utilities
   • eventDispatcher.lua, logger.lua: Support debugging and event handling.

---

Getting Started

Prerequisites

• Lua installed (source)
• A VR headset (optional for development).

Installation

1. Clone this repository:

   git clone https://github.com/axlfc/protocol-escape-game.git
   cd protocol-escape-game

2. Extract LÖVR files in the repository.

3. Run the project:

   • Windows:

       .\lovr.exe .

     or drag-and-drop the main.lua file onto lovr.exe or lovrc.bat
   • macOS/Linux:

       lovr .

---

Controls

• Interact: Press the trigger on your VR controller.
• Move: Use the thumbstick or trackpad.
• Menu: Access with the menu button.

---

Contact

Follow me, Axlfc, on:

• GitHub

---

Happy coding! 🚀