Skip to content

README.md

Latest commit

 

History

History
72 lines (53 loc) · 3.45 KB

README.md

File metadata and controls

72 lines (53 loc) · 3.45 KB
Raw

Asobi Arena Demo (Defold)

Top-down arena shooter demo for the Asobi game backend, built with Defold and the asobi-defold SDK.

Quick Start

New here? Follow GETTING_STARTED.md for full step-by-step setup on Windows, Linux, and macOS. The short version:

  1. Start the backend: asobi dev (needs the asobi CLI + Docker). The full arena game logic (boons, modifiers, voting, bots) is bundled in lua/, so this one command serves it on http://localhost:8084.
  2. Add the SDK: clone asobi-defold and copy its asobi/ folder into this repo (the folder is git-ignored). Copying works on every OS with no admin rights; see the guide for the symlink alternative.
  3. Run it: open game.project in the Defold editor, Project -> Fetch Libraries, then press F5. This is identical on every OS.

The bob.jar CLI build (with per-OS platform strings) is in the getting-started appendix.

Server Selection

On launch you choose which server to connect to:

  • LOCAL — localhost:8084 (the bundled lua/ arena, run with asobi dev)
  • PLAY ONLINE — play.asobi.dev (production server)

Game Flow

  1. Server Select — Choose local or online server
  2. Login — Register or log in with username and password
  3. Lobby — Connect via WebSocket, queue for matchmaking
  4. Countdown — 3-2-1 before arena starts
  5. Arena — 90-second rounds, shoot enemies, collect kills
  6. Boon Pick — Top 3 players choose an upgrade
  7. Voting — All players vote on next round's modifier
  8. Results — Standings, leaderboard, auto-queue for next match

Controls

Input Action
W / A / S / D Move up / left / down / right
Mouse Aim
Left Click Shoot
Tab Switch input field (login)
Enter Confirm (login)

Architecture

Single collection with a controller script managing game state transitions. GUI screens (server select, login, lobby, countdown, arena, boon pick, voting, results) are toggled via enable/disable. The arena renders ship sprites and cannonball projectiles using textures from the ships atlas.

Server-authoritative: the client sends inputs at 60fps, the server responds with game state at 10Hz. All collision, damage, and kill logic runs server-side.

Key Files

File Purpose
main/controller.script State machine, input routing, WebSocket callbacks
main/game_config.lua Shared config, colors, cross-GUI data
arena/arena.gui_script Arena rendering (ships, projectiles, HUD)
boon/boon.gui_script Boon card selection UI
vote/vote.gui_script Modifier voting with live tallies
server/server.gui_script Server selection (local/online)
asobi/ SDK source — HTTP client, WebSocket, API modules (see "Install the SDK" above)

Assets

File Description
assets/player.png Player ship sprite (52x53)
assets/enemy.png Enemy ship sprite (52x53)
assets/cannonball.png Projectile sprite (8x8)
assets/ship_player.png Player sprite sheet (3x4 grid)
assets/ship_enemy.png Enemy sprite sheet (3x4 grid)
assets/ships.atlas Defold atlas combining all sprites