constants.py

'''Terminal Worm: A remake of the classic Snake game
    Copyright (C) 2012, 2013  Yuri Pieters

    Terminal Worm is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Terminal Worm is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.


All the constants for the game.
They are:
  - LEFT
  - RIGHT
  - UP
  - DOWN
  - ADJUSTMAP
  - APPLECHR
  - WINWIDTH
  - WINHEIGHT
  - WALLCHR
  - SCOREPOS
  - HEADCHR
  - BODYCHR
  - INITPOS
  - INITLENGTH
  - INITSPEED
  - WALL_KILL
  - CONTROL_KEYS
  - BUG_CHRS
  - BUG_TIMEOUT_RANGE
  - BUG_TIMER_POS
'''

# Direction constants
LEFT = 'left'
RIGHT = 'right'
UP = 'up'
DOWN = 'down'

ADJUSTMAP = {
    LEFT:  [ 0, -1],  # noqa
    RIGHT: [ 0,  1],  # noqa
    UP:    [-1,  0],  # noqa
    DOWN:  [ 1,  0]   # noqa
}

# NB: For configuration purposes, only things
#     below here should need to be changed
# ============================================


APPLECHR = 'O'

# Game window constants
WINHEIGHT = 20
WINWIDTH = 60

assert WINHEIGHT % 2 == 0 and WINWIDTH % 2 == 0, (
    'Window height and window width need to be even numbers')
# This makes life easier, because then we can do things
# like halve the window size and still end up with whole numbers

WALLCHR = '*'
SCOREPOS = [0, WINWIDTH - 4]

# Snake constants
HEADCHR = '@'
BODYCHR = 'o'
INITPOS = [int(WINHEIGHT / 2), int(WINWIDTH / 2)]  # The middle
INITLENGTH = 4
assert (INITPOS[1] - INITLENGTH > 0 and
        INITPOS[1] < WINWIDTH and
        INITPOS[0] > 0 and
        INITPOS[0] < WINHEIGHT), (
    'The snake needs to start in the window! '
    'Remember, the snake is not in the window if '
    'INITPOS - INITLENGTH goes outside the window')

# Intial speed, in milliseconds
INITSPEED = 150

# Set to True if you want running into walls to mean
# Game Over.
WALL_KILL = False

CONTROL_KEYS = {LEFT: 'h', DOWN: 'j', UP: 'k', RIGHT: 'l'}
# While the arrow keys will always be available, you can set up an
# additional set of keys to control the snake.
# The default alternative is "HJKL", but if you want to use something
# else, such as "WASD", or your keyboard layout is'nt QWERTY,
# (dvorak, for example) then you can set it up here.
# An example for an alternative mapping, might be:
# CONTROL_KEYS = {LEFT: 'h', DOWN: 't', UP: 'n', RIGHT: 's'}
# Which is is "HJKL" remapped for dvorak, so that your hands are still
# on the home row.

BUG_CHRS = ('#', '~', '%', '∞', '§', '≈', '¥', '∑')
BUG_TIMEOUT_RANGE = (30, 40)
BUG_TIMER_POS = [0, WINWIDTH - 17]