lib/invaders.lua.in

   1 ----------------------------------------------------------------------------
   2 -- @author Gregor "farhaven" Best
   3 -- @copyright 2008 Gregor "farhaven" Best
   4 -- @release @AWESOME_VERSION@
   5 ----------------------------------------------------------------------------
   6
   7 --{{{ Awesome Invaders by Gregor "farhaven" Best
   8 -- The ultra-cool retro graphics are done by Andrei "Garoth" Thorp.
   9 --
  10 -- Use Left and Right to control motion, Space to fire, q quits the game,
  11 -- s creates a screenshot in ~/.cache/awesome (needs ImageMagick).
  12 --
  13 -- Maybe there are some huge memory leaks here and there, if you notice one,
  14 -- message me.
  15 --
  16 -- Anyway, have fun :)
  17 --
  18 -- Start this by adding
  19 -- require("invaders")
  20 -- to the top of your rc.lua and adding
  21 -- invaders.run()
  22 -- to the bottom of rc.lua or as a keybinding
  23 --}}}
  24
  25 local wibox = wibox
  26 local widget = widget
  27 local awful = require("awful")
  28 local beautiful = require("beautiful")
  29 local image = image
  30 local capi = { screen = screen, mouse = mouse, keygrabber = keygrabber }
  31
  32 local tonumber = tonumber
  33 local table = table
  34 local math = math
  35 local os = os
  36 local io = io
  37
  38 --- Space Invaders look-alike
  39 module("invaders")
  40
  41 local gamedata = { }
  42 gamedata.field = { }
  43 gamedata.field.x = 100
  44 gamedata.field.y = 100
  45 gamedata.field.h = 400
  46 gamedata.field.w = 600
  47 gamedata.running = false
  48 gamedata.highscore = { }
  49 gamedata.enemies = { }
  50 gamedata.enemies.h = 10
  51 gamedata.enemies.w = 20
  52 gamedata.enemies.rows = 5
  53 gamedata.enemies.count = gamedata.enemies.rows * 6
  54 gamedata.enemies[1] = image("@AWESOME_ICON_PATH@/invaders/enemy_1.png")
  55 gamedata.enemies[2] = image("@AWESOME_ICON_PATH@/invaders/enemy_2.png")
  56 gamedata.enemies[3] = image("@AWESOME_ICON_PATH@/invaders/enemy_3.png")
  57
  58 local player = { }
  59 local game = { }
  60 local shots = { }
  61 local enemies = { }
  62
  63 function player.new ()
  64     p = wibox({ position = "floating",
  65                 bg = gamedata.solidbg or "#12345600" })
  66     p:geometry({ width = 24,
  67                  height = 16,
  68                  x = gamedata.field.x + (gamedata.field.w / 2),
  69                  y = gamedata.field.y + gamedata.field.h - (16 + 5) })
  70     p.screen = 1
  71
  72     w = widget({ type = "imagebox" })
  73     w.image = image("@AWESOME_ICON_PATH@/invaders/player.png")
  74     p.widgets = w
  75
  76     return p
  77 end
  78
  79 function player.move(x)
  80     if not gamedata.running then return false end
  81     local g = gamedata.player:geometry()
  82
  83     if x < 0 and g.x > gamedata.field.x then
  84         g.x = g.x + x
  85     elseif x > 0 and g.x < gamedata.field.x + gamedata.field.w - 30 then
  86         g.x = g.x + x
  87     end
  88
  89     gamedata.player:geometry(g)
  90 end
  91
  92 function player.fire()
  93     if not gamedata.running then return false end
  94     if gamedata.ammo == 1 then
  95         gamedata.ammo = 0
  96         local gb = gamedata.player:geometry()
  97         shots.fire(gb.x + 9, gb.y - 10, "#00FF00")
  98     end
  99 end
 100
 101 function shots.fire (x, y, color)
 102     local s = wibox({ position = "floating",
 103                       bg = color })
 104     s:geometry({ width = 4,
 105                  height = 10,
 106                  x = x,
 107                  y = y })
 108     s.screen = 1
 109
 110     if not gamedata.shot or gamedata.shot.screen == nil then
 111             gamedata.shot = s
 112     end
 113 end
 114
 115 function shots.fire_enemy (x, y, color)
 116     if gamedata.enemies.shots.fired < gamedata.enemies.shots.max then
 117         gamedata.enemies.shots.fired = gamedata.enemies.shots.fired + 1
 118         local s = wibox({ position = "floating",
 119                           bg = color })
 120         s:geometry({ width = 4,
 121                      height = 10,
 122                      x = x,
 123                      y = y })
 124         s.screen = 1
 125         for i = 1, gamedata.enemies.shots.max do
 126             if not gamedata.enemies.shots[i] or gamedata.enemies.shots[i].screen == nil then
 127                 gamedata.enemies.shots[i] = s
 128                 break
 129             end
 130         end
 131     end
 132 end
 133
 134 function shots.handle()
 135     if not gamedata.running then return false end
 136     if gamedata.ammo == 1 then return false end
 137
 138     local s = gamedata.shot
 139     if s and s.screen then
 140         gamedata.ammo = 0
 141         local g = s:geometry()
 142         if g.y < gamedata.field.y + 15 then
 143             s.screen = nil
 144             gamedata.ammo = 1
 145         else
 146             g.y = g.y - 6
 147             s:geometry(g)
 148         end
 149     end
 150 end
 151
 152
 153 function shots.handle_enemy ()
 154     if not gamedata.running then return false end
 155     if gamedata.enemies.shots.fired == 0 then return false end
 156
 157     for i = 1, gamedata.enemies.shots.max do
 158         local s = gamedata.enemies.shots[i]
 159         if s and s.screen then
 160             local g = s:geometry()
 161             if g.y > gamedata.field.y + gamedata.field.h - 15 then
 162                 s.screen = nil
 163                 gamedata.enemies.shots.fired = gamedata.enemies.shots.fired - 1
 164             else
 165                 g.y = g.y + 3
 166                 s:geometry(g)
 167             end
 168             if game.collide(gamedata.player, s) then
 169                 game.over()
 170             end
 171         end
 172     end
 173 end
 174
 175 function enemies.new (t)
 176     e = wibox({ position = "floating",
 177                 bg = gamedata.solidbg or "#12345600" })
 178     e:geometry({ height = gamedata.enemies.h,
 179                  width = gamedata.enemies.w,
 180                  x = gamedata.field.x,
 181                  y = gamedata.field.y })
 182     e.screen = 1
 183     w = widget({ type = "imagebox" })
 184     w.image = gamedata.enemies[t]
 185
 186     e.widgets = w
 187     return e
 188 end
 189
 190 function enemies.setup()
 191     gamedata.enemies.data = { }
 192     gamedata.enemies.x = 10
 193     gamedata.enemies.y = 5
 194     gamedata.enemies.dir = 1
 195     if not gamedata.enemies.shots then gamedata.enemies.shots = { } end
 196     gamedata.enemies.shots.max = 10
 197     gamedata.enemies.shots.fired = 0
 198
 199     gamedata.enemies.speed_count = 0
 200
 201     for y = 1, gamedata.enemies.rows do
 202         gamedata.enemies.data[y] = { }
 203         for x = 1, math.ceil((gamedata.enemies.count / gamedata.enemies.rows) + 1) do
 204             gamedata.enemies.data[y][x] = enemies.new((y % 3) + 1)
 205         end
 206     end
 207
 208     if gamedata.shot then
 209         gamedata.shot.screen = nil
 210     end
 211
 212     for i = 1, gamedata.enemies.shots.max do
 213         if gamedata.enemies.shots[i] then
 214             gamedata.enemies.shots[i].screen = nil
 215         end
 216     end
 217 end
 218
 219 function enemies.handle ()
 220     if not gamedata.running then return false end
 221
 222     gamedata.enemies.number = 0
 223
 224     for y = 1, #gamedata.enemies.data do
 225         for x = 1, #gamedata.enemies.data[y] do
 226             local e = gamedata.enemies.data[y][x]
 227             if e.screen then
 228                 local g = e:geometry()
 229                 gamedata.enemies.number = gamedata.enemies.number + 1
 230                 if gamedata.enemies.speed_count == (gamedata.enemies.speed - 1) then
 231                     g.y = math.floor(gamedata.field.y + gamedata.enemies.y + ((y - 1) * gamedata.enemies.h * 2))
 232                     g.x = math.floor(gamedata.field.x + gamedata.enemies.x + ((x - 1) * gamedata.enemies.w * 2))
 233                     e:geometry(g)
 234                     if game.collide(gamedata.player, e) or g.y > gamedata.field.y + gamedata.field.h - 20 then
 235                         game.over()
 236                     end
 237                 end
 238                 if gamedata.ammo == 0 then
 239                         local s = gamedata.shot
 240                         if s and s.screen and game.collide(e, s) then
 241                         gamedata.enemies.number = gamedata.enemies.number - 1
 242                         gamedata.ammo = 1
 243                         e.screen = nil
 244                         s.screen = nil
 245
 246                         if (y % 3) == 0 then
 247                             gamedata.score = gamedata.score + 15
 248                         elseif (y % 3) == 1 then
 249                             gamedata.score = gamedata.score + 10
 250                         else
 251                             gamedata.score = gamedata.score + 5
 252                         end
 253                         gamedata.field.status.text = gamedata.score.." | "..gamedata.round.."  "
 254                     end
 255                 end
 256             end
 257         end
 258
 259         local x = math.random(1, gamedata.enemies.count / gamedata.enemies.rows)
 260         if gamedata.enemies.speed_count == (gamedata.enemies.speed - 1)
 261             and math.random(0, 150) <= 1
 262             and gamedata.enemies.data[y][x].screen then
 263             shots.fire_enemy(math.floor(gamedata.field.x + gamedata.enemies.x + ((x - 1) * gamedata.enemies.w)),
 264                              gamedata.field.y + gamedata.enemies.y + gamedata.enemies.h,
 265                              "#FF0000")
 266         end
 267     end
 268
 269     if gamedata.enemies.number == 0 then
 270         enemies.setup()
 271         gamedata.round = gamedata.round + 1
 272         gamedata.field.status.text = gamedata.score.." | "..gamedata.round.."  "
 273         if gamedata.enemies.speed > 1 then gamedata.enemies.speed = gamedata.enemies.speed - 1 end
 274         return false
 275     end
 276
 277     gamedata.enemies.speed_count = gamedata.enemies.speed_count + 1
 278     if gamedata.enemies.speed_count < gamedata.enemies.speed then return false end
 279     gamedata.enemies.speed_count = 0
 280     gamedata.enemies.x = gamedata.enemies.x + math.floor((gamedata.enemies.w * gamedata.enemies.dir) / 4)
 281     if gamedata.enemies.x > gamedata.field.w - (2 * gamedata.enemies.w * (gamedata.enemies.count / gamedata.enemies.rows + 1)) + 5
 282         or gamedata.enemies.x <= 10 then
 283         gamedata.enemies.y = gamedata.enemies.y + gamedata.enemies.h
 284         gamedata.enemies.dir = gamedata.enemies.dir * (-1)
 285     end
 286 end
 287
 288 function keyhandler(mod, key, event)
 289     if event ~= "press" then return true end
 290     if gamedata.highscore.getkeys then
 291         if key:len() == 1 and gamedata.name:len() < 20 then
 292             gamedata.name = gamedata.name .. key
 293         elseif key == "BackSpace" then
 294             gamedata.name = gamedata.name:sub(1, gamedata.name:len() - 1)
 295         elseif key == "Return" then
 296             gamedata.highscore.window.screen = nil
 297             game.highscore_add(gamedata.score, gamedata.name)
 298             game.highscore_show()
 299             gamedata.highscore.getkeys = false
 300         end
 301         gamedata.namebox.text = " Name: " .. gamedata.name .. "|"
 302     else
 303         if key == "Left" then
 304             player.move(-10)
 305         elseif key == "Right" then
 306             player.move(10)
 307         elseif key == "q" then
 308             game.quit()
 309             return false
 310         elseif key == " " then
 311             player.fire()
 312         elseif key == "s" then
 313             awful.util.spawn("import -window root "..gamedata.cachedir.."/invaders-"..os.time()..".png")
 314         elseif key == "p" then
 315             gamedata.running = not gamedata.running
 316         end
 317     end
 318     return true
 319 end
 320
 321 function game.collide(o1, o2)
 322     g1 = o1:geometry()
 323     g2 = o2:geometry()
 324
 325     --check if o2 is inside o1
 326     if g2.x >= g1.x and g2.x <= g1.x + g1.width
 327         and g2.y >= g1.y and g2.y <= g1.y + g1.height then
 328         return true
 329     end
 330
 331     return false
 332 end
 333
 334 function game.over ()
 335     gamedata.running = false
 336     game.highscore(gamedata.score)
 337 end
 338
 339 function game.quit()
 340     gamedata.running = false
 341
 342     if gamedata.highscore.window then
 343         gamedata.highscore.window.screen = nil
 344         gamedata.highscore.window.widgets = nil
 345     end
 346
 347     if gamedata.field.background then
 348        gamedata.field.background.screen = nil
 349     end
 350
 351     gamedata.player.screen = nil
 352     gamedata.player.widgets = nil
 353     gamedata.player = nil
 354
 355     gamedata.field.north.screen = nil
 356     gamedata.field.north = nil
 357
 358     gamedata.field.south.screen = nil
 359     gamedata.field.south = nil
 360
 361     gamedata.field.west.screen = nil
 362     gamedata.field.west = nil
 363
 364     gamedata.field.east.screen = nil
 365     gamedata.field.east = nil
 366
 367     for y = 1, #gamedata.enemies.data do
 368         for x = 1, #gamedata.enemies.data[y] do
 369             gamedata.enemies.data[y][x].screen = nil
 370             gamedata.enemies.data[y][x].widgets = nil
 371         end
 372     end
 373
 374     if gamedata.shot then gamedata.shot.screen = nil end
 375
 376     for i = 1, gamedata.enemies.shots.max do
 377         if gamedata.enemies.shots[i] then gamedata.enemies.shots[i].screen = nil end
 378     end
 379 end
 380
 381 function game.highscore_show ()
 382     gamedata.highscore.window:geometry({ height = 140,
 383                                          width = 200,
 384                                          x = gamedata.field.x + math.floor(gamedata.field.w / 2) - 100,
 385                                          y = gamedata.field.y + math.floor(gamedata.field.h / 2) - 55 })
 386     gamedata.highscore.window.screen = 1
 387
 388     gamedata.highscore.table = widget({ type = "textbox" })
 389     gamedata.highscore.window.widgets =  gamedata.highscore.table
 390
 391     gamedata.highscore.table.text = " Highscores:\n"
 392
 393     for i = 1, 5 do
 394         gamedata.highscore.table.text = gamedata.highscore.table.text .. "\n\t" .. gamedata.highscore[i]
 395     end
 396
 397     gamedata.highscore.table.text = gamedata.highscore.table.text .. "\n\n Press Q to quit"
 398
 399     local fh = io.open(gamedata.cachedir.."/highscore_invaders", "w")
 400
 401     if not fh then
 402         return false
 403     end
 404
 405     for i = 1, 5 do
 406         fh:write(gamedata.highscore[i].."\n")
 407     end
 408
 409     fh:close()
 410 end
 411
 412 function game.highscore_add (score, name)
 413     local t = gamedata.highscore
 414
 415     for i = 5, 1, -1 do
 416         if tonumber(t[i]:match("(%d+) ")) <= score then
 417             if t[i+1] then t[i+1] = t[i] end
 418             t[i] = score .. " " .. name
 419         end
 420     end
 421
 422     gamedata.highscore = t
 423 end
 424
 425 function game.highscore (score)
 426     if gamedata.highscore.window and gamedata.highscore.window.screen then return false end
 427     local fh = io.open(gamedata.cachedir.."/highscore_invaders", "r")
 428
 429     if fh then
 430         for i = 1, 5 do
 431         gamedata.highscore[i] = fh:read("*line")
 432         end
 433         fh:close()
 434     else
 435         for i = 1, 5 do
 436             gamedata.highscore[i] = ((6-i)*20).." foo"
 437         end
 438     end
 439
 440     local newentry = false
 441     for i = 1, 5 do
 442         local s = tonumber(gamedata.highscore[i]:match("(%d+) .*"))
 443         if s <= score then newentry = true end
 444     end
 445
 446     gamedata.highscore.window = wibox({ position = "floating",
 447                                         bg = gamedata.btheme.bg_focus or "#333333",
 448                                         fg = gamedata.btheme.fg_focus or "#FFFFFF" })
 449     gamedata.highscore.window:geometry({ height = 20,
 450                                          width = 300,
 451                                          x = gamedata.field.x + math.floor(gamedata.field.w / 2) - 150,
 452                                          y = gamedata.field.y + math.floor(gamedata.field.h / 2) })
 453     gamedata.highscore.window.screen = 1
 454
 455     gamedata.namebox = widget({ type = "textbox" })
 456     gamedata.namebox.text = " Name: |"
 457     gamedata.highscore.window.widgets = gamedata.namebox
 458
 459     if newentry then
 460         gamedata.name = ""
 461         gamedata.highscore.getkeys = true
 462     else
 463         game.highscore_show()
 464     end
 465 end
 466
 467 --- Run Awesome Invaders
 468 -- @param args A table with parameters.
 469 -- x the X coordinate of the playing field.
 470 -- y the Y coordinate of the playing field.
 471 -- if either of these is left out, the game is placed in the center of the focused screen.
 472 -- solidbg the background color of the playing field. If none is given, the playing field is transparent.
 473 function run(args)
 474     gamedata.screen = capi.screen[capi.mouse.screen]
 475     gamedata.field.x = gamedata.screen.geometry.x + math.floor((gamedata.screen.geometry.width - gamedata.field.w) / 2)
 476     gamedata.field.y = gamedata.screen.geometry.y + math.floor((gamedata.screen.geometry.height - gamedata.field.h) / 2)
 477
 478     if args then
 479        if args['x'] then gamedata.field.x = args['x'] end
 480        if args['y'] then gamedata.field.y = args['y'] end
 481        if args['solidbg'] then gamedata.solidbg = args['solidbg'] end
 482     end
 483
 484     gamedata.score = 0
 485     gamedata.name = ""
 486     gamedata.ammo = 1
 487     gamedata.round = 1
 488     gamedata.btheme = beautiful.get()
 489
 490     gamedata.cachedir = awful.util.getdir("cache")
 491
 492     if gamedata.solidbg then
 493        gamedata.field.background = wibox({ position = "floating",
 494                                            bg = gamedata.solidbg })
 495        gamedata.field.background:geometry({ x = gamedata.field.x,
 496                                             y = gamedata.field.y,
 497                                             height = gamedata.field.h,
 498                                             width = gamedata.field.w })
 499        gamedata.field.background.screen = 1
 500     end
 501
 502     gamedata.field.north = wibox({ position = "floating",
 503                                    bg = gamedata.btheme.bg_focus or "#333333",
 504                                    fg = gamedata.btheme.fg_focus or "#FFFFFF" })
 505     gamedata.field.north:geometry({ width = gamedata.field.w + 10,
 506                                     height = 15,
 507                                     x = gamedata.field.x - 5,
 508                                     y = gamedata.field.y - 15 })
 509     gamedata.field.north.screen = 1
 510
 511     gamedata.field.status = widget({ type = "textbox",
 512                                      align = "right" })
 513     gamedata.field.status.text = gamedata.score.." | "..gamedata.round .. "  "
 514
 515     gamedata.field.caption = widget({ type = "textbox",
 516                                       align = "left" })
 517     gamedata.field.caption.text = "  Awesome Invaders"
 518
 519     gamedata.field.north.widgets = { gamedata.field.caption, gamedata.field.status }
 520
 521     gamedata.field.south = wibox({ position = "floating",
 522                                    bg = gamedata.btheme.bg_focus or "#333333",
 523                                    fg = gamedata.btheme.fg_focus or "#FFFFFF" })
 524     gamedata.field.south:geometry({ width = gamedata.field.w,
 525                                     height = 5,
 526                                     x = gamedata.field.x,
 527                                     y = gamedata.field.y + gamedata.field.h - 5 })
 528     gamedata.field.south.screen = 1
 529
 530     gamedata.field.west = wibox({ position = "floating",
 531                                   bg = gamedata.btheme.bg_focus or "#333333",
 532                                   fg = gamedata.btheme.fg_focus or "#FFFFFF" })
 533     gamedata.field.west:geometry({ width = 5,
 534                                    height = gamedata.field.h,
 535                                    x = gamedata.field.x - 5,
 536                                    y = gamedata.field.y })
 537     gamedata.field.west.screen = 1
 538
 539     gamedata.field.east = wibox({ position = "floating",
 540                                   bg = gamedata.btheme.bg_focus or "#333333",
 541                                   fg = gamedata.btheme.fg_focus or "#FFFFFF" })
 542     gamedata.field.east:geometry({ width = 5,
 543                                    height = gamedata.field.h,
 544                                    x = gamedata.field.x + gamedata.field.w,
 545                                    y = gamedata.field.y })
 546     gamedata.field.east.screen = 1
 547
 548     gamedata.enemies.speed = 5
 549     enemies.setup()
 550
 551     gamedata.player = player.new()
 552     capi.keygrabber.run(keyhandler)
 553     gamedata.running = true
 554 end
 555
 556 awful.hooks.timer.register(0.02, shots.handle)
 557 awful.hooks.timer.register(0.03, shots.handle_enemy)
 558 awful.hooks.timer.register(0.01, enemies.handle)