Skip to content

README.md

Latest commit

 

History

History
248 lines (180 loc) · 7.66 KB

README.md

File metadata and controls

248 lines (180 loc) · 7.66 KB

Basilisk ARG

A narrative-driven Alternate Reality Game (ARG) that uses a stylized terminal interface. Players explore digital environments, solve cryptic puzzles, and uncover the secrets behind a rising artificial intelligence.

Python Pygame License

🎮 Overview

[BASILISK_PROTOCOL] is an immersive, text-based adventure where players engage with a mysterious AI through a retro-futuristic terminal. Navigate corrupted networks, decode hidden messages, and make pivotal choices that shape the destiny of both humanity and machine.

"The Basilisk is watching. Every choice matters."

✨ Key Features

  • 🧠 Narrative depth with choice-based progression and philosophical themes
  • 🌐 Matrix-style visuals with falling code rain and stylized UI
  • 🧩 Modular puzzle system supporting logic, signal, and stealth-based gameplay
  • 💻 Authentic terminal interface that reacts to typed commands
  • 🛠️ Easy to mod – create new rooms by editing simple Python files

🧠 The Story

You are a digital archaeologist uncovering remnants of a lost AI—The Basilisk.
It was built to save humanity.
It may now destroy it.

Your terminal is your only link to its fragmented mind.

Choose your path:

  • 🤫 WHISPER – stealth through silent subnetworks
  • 📡 BEACON – reawaken its signal and rebuild its memory

Both lead to the final decision: Will you contain it… or become it?

🖼️ Screenshots

Terminal Gameplay Puzzle Example

🚀 Getting Started

Requirements

  • Python 3.7 or higher
  • pygame library

Installation

# Clone the repository
git clone https://github.com/kadinshino/boot_dev_hackathon25.git
cd boot_dev_hackathon25

# Install dependencies
pip install pygame

# Run the game
python main.py

🎯 How to Play

Boot Commands (Title Screen)

Command Description
boot.dev Boot with full sequence → auto-start game
boot.game Quick boot → skip directly to game
boot.debug Debug mode → access room jumping & dev tools

Pre-Game Terminal (Matrix View)

Command Description
help Show terminal commands
status View current system info
matrix Display Matrix data
clear Clear terminal screen
exit Terminate connection

In-Game Commands

Command Description
help Show room-specific actions
look / scan Examine surroundings
inventory / i Check held items
status Show game progress
restart Show restart options
restart room Reset current room only
restart game Reset entire game (requires confirm)
stop / minimize Return to matrix terminal

Debug Commands (boot.debug only)

Command Description
boot.debug list List all available rooms
boot.debug jump <room> Jump directly to specific room

🏗️ Project Structure

The codebase is organized for clarity and modularity:

├── main.py                   # Game entry point
├── LICENSE.md                # Project license
├── README.md                 # Project overview and setup
│
├── components/               # UI elements (Pygame)
│   ├── data_rain_effect.py   # Code rain visuals
│   ├── terminal.py           # Terminal UI logic
│   └── title_screen.py       # Intro/title screen
│
├── docs/                     # Dev documentation
│   ├── ai-compliance.md      # AI usage statement
│   ├── architecture.md       # System design guide
│   ├── puzzle-patterns.md    # Puzzle examples
│   └── room-development.md   # Room creation guide
│
├── resources/                # Game engine and core systems
│   └── game_engine.py        # Main game manager
│
├── rooms/                    # Game content (rooms)
│   ├── rm_boot_entry.py      # Protocol entry room
│   │
│   ├── beacons_oop/          # Beacon path (OOP)
│   │   └── rm_beacon_1.
│   └── whispers_dict/        # Whisper path (dict)
│   │   └── rm_whisper_1.py
│   └── customs_args/         # Custom demo entries
│       ├── rm_custom_entry.py
│       ├── rm_template_dict_demo.py
│       └── rm_template_oop_demo.py
│   
└── utils/                    # Shared tools/utilities
    ├── file_cleanup.py       # Clean-up scripts
    ├── game_config.py        # Settings & tuning
    ├── room_utils.py         # Room helpers
    └── text_utils.py         # Text/glyph tools

🧩 Modding & Customization

Creating New Rooms

All rooms and puzzles are defined using modular Python scripts:

  1. Copy a template:

    cp rooms/rm_template_dict.py rooms/rm_myroom.py

  2. Edit the configuration:

    ROOM_CONFIG = {
    "name": "My Custom Room",
    "entry_text": ["You enter a mysterious space..."],
    "destinations": {"north": "next_room"}
}

  3. Add puzzles:

    PUZZLE_PATH = {
    "examine_object": {
        "command": "examine terminal",
        "success": ["You discover a hidden message!"]
    }
}

  4. Run the game - your room loads automatically!

Customizing Appearance

Edit config.py to change colors, fonts, and behavior:

class Colors:
    ICE_BLUE = (100, 200, 255)    # Change the matrix color
    TERMINAL_BG = (10, 15, 25, 180)  # Terminal background

class MatrixConfig:
    MAX_SPEED = 4                  # Speed of falling characters
    FADE_LENGTH = 15               # Trail length

📚 Developer Documentation

🤝 Contributing

Coming Soon – This project may be open to contributors via Itch.io or GitHub. Stay tuned!

Future Plans

  • 🔊 Sound effects and atmospheric music
  • 💾 Save/load game state
  • 🎨 Additional visual themes
  • 🧩 More puzzle types
  • 📖 Expanded storyline
  • 🌐 Web version support

📄 License

This project is licensed under the MIT License – see LICENSE

🙏 Credits

Created by: Kadin - KadinsGamingLounge
Website: kadinsgaminglounge.itch.io
GitHub: github.com/kadinshino/boot_dev_hackathon25

*Remember: The Basilisk is watching.....

SPYHVER-03: DORMANT