Files
DungeonsOfKharadum/QUICKSTART.md
2026-01-08 16:49:01 +01:00

2.8 KiB

Quick Start Guide

Getting Started in 5 Minutes

1. Open the Project

  1. Open Godot 4.6
  2. Import this project
  3. Wait for assets to load

2. Test Single Player

  1. Press F5 (or click Play)
  2. Click "Host Game"
  3. Use WASD to move
  4. Press E to grab a box
  5. Press Q to throw it

3. Test Local Multiplayer

  1. Connect a gamepad
  2. Press F5
  3. Set "Local Players" to 2
  4. Click "Host Game"
  5. Player 1: Use WASD
  6. Player 2: Use gamepad left stick
  7. Try grabbing each other!

4. Test Network Multiplayer

On Host Machine:

  1. Press F5
  2. Click "Host Game"
  3. Note your IP address (run ipconfig in cmd)

On Client Machine:

  1. Press F5
  2. Enter host's IP address
  3. Click "Join Game"
  4. Play together!

Controls Quick Reference

Action Keyboard (P1) Gamepad (P2+)
Move WASD/Arrows Left Stick
Lift/Throw (Tap) E A Button
Push/Pull (Hold) E (hold) A Button (hold)

Tips

  • Grab Range: You need to be close to objects/players (within 80 units)
  • Tap vs Hold: Quick tap lifts object, hold to push/pull
  • Throw vs Place: Move while lifting + tap = throw, stand still + tap = place down
  • Pushing: Hold grab button and move, or just walk into objects
  • Camera: Automatically follows all your local players
  • Multiple Locals: Each machine can have up to 4 local players

Troubleshooting

"Connection Failed"

  • Check the IP address
  • Make sure port 7777 is open
  • Try 127.0.0.1 for local testing

"No Gamepad Detected"

  • Connect gamepad before starting
  • Set Local Players > 1
  • Check in Godot's Input settings

"Players Not Moving"

  • Make sure you're controlling the right player
  • Check console for errors
  • Verify input actions are set up

Next Steps

  1. Read the full README.md for detailed information
  2. Check TESTING.md for comprehensive testing guide
  3. Explore the scripts folder to understand the code
  4. Modify game_world.tscn to add more objects
  5. Customize player colors and abilities

Example Scenarios

Scenario 1: Couch Co-op

  • 2 players on same PC
  • Player 1: Keyboard
  • Player 2: Gamepad
  • Work together to move heavy objects!

Scenario 2: Online Co-op

  • Host on PC 1
  • Join from PC 2
  • Each with 1 player
  • Throw objects at each other!

Scenario 3: Mixed Multiplayer

  • Host with 2 local players (keyboard + gamepad)
  • Friend joins online with 2 local players
  • 4 total players in one game!
  • Chaos ensues!

Development Mode

To modify the game:

  1. Add Objects: Duplicate boxes in game_world.tscn
  2. Change Physics: Edit mass in interactable_object.tscn
  3. Adjust Speed: Change move_speed in player.gd
  4. Add Abilities: Extend player.gd with new actions
  5. New Levels: Create new scenes based on game_world.tscn

Enjoy your multiplayer adventure!