readme.md

   1 # Sports Pickem Module
   2
   3 Run a sports pickem league using Drupal. It can be used for the NFL, NHL, College Bowl season, March Madness, MLS, etc...
   4 Includes pick the winner style along with point spread support.
   5
   6 ## Features
   7
   8 * Import-export of game sets feature so you can share team lists and schedules with other users of this module.
   9 * Multi-league: more than one league can use the same gameset so the commish need only enter the scores once!
  10 * Multi-gameset: you can run more than one sport (or division) at one time.
  11 * Email reminders: let people know when the pick lock-up time will come.
  12 * Charts(*): gotta have pretty charts:) <a href="http://drupal.org/project/open_flash_chart_api">Open_Flash_Chart_API</a>.
  13 * Dynamic timer(*): let people know when the picks are due by <a href="http://drupal.org/project/jstimer">Javascript Timer</a>.
  14 * Automatic score updates(*): Not having to type in those pesky sports scores...priceless. Service provided by <a href="http://drupal.org/project/sports_scores">Sports Scores</a>.
  15
  16 (*) Optional integration will other Drupal modules.
  17
  18 ## Installation and Setup
  19
  20 ### Install the sports pickem module
  21
  22 1. Download and install the <a href="http://drupal.org/project/pickem">Sports Pickem Module</a>
  23 2. Enable the Sports Pickem Module on the admin/modules page.
  24
  25 ### If you want to use the forum module for chat and banter:
  26
  27 1. Enable the Forum on the admin/modules page
  28 2. Add a Forum for chat and league banter.
  29
  30 ### If you want to have a rules and regulations page:
  31
  32 1. Add a Standard Page/Story/Node or a Forum Post for an explanation of the rules of the league, and remember the node id of the post.
  33
  34 ### Create your first league:
  35
  36 1. Import a gameset or type one in. You'll need teams, weeks, and games.
  37 2. Add a League (/admin/content/pickem/leagues) and choose the linked forum* and the Rules node id* from above.
  38 3. Add users to the league (admin/content/pickem/league_users)
  39 4. Enable and show the Pickem Leagues block (admin/build/block)
  40
  41 This user will then see the league menus under "My leagues".
  42
  43 ### If you want a dynamic countdown timer which will countdown to the next week pick lockup time:
  44
  45 1. Download and install Javascript Countdown Timer module. (http://drupal.org/project/countdowntimer)
  46 2. Make sure to configure Javascript Countdown Timer to show on 'Every Page' in its admin screen. (admin/settings/countdowntimer)
  47
  48 ### If you want pretty flash charts:
  49
  50 1. Download and install Open Flash Chart API. (http://drupal.org/project/open_flash_chart_api) requires additional steps listed in the modules documentation.
  51
  52 ### Remember
  53
  54 * Set the "access pickem" and "play pickem" permissions for your users.
  55 * If you are using the javascript countdown timer, go to its admin page and select "Every Page".
  56 * For a pickem-only site, set the "access denied" page to be some kind of info page explaining that you must login
  57 * For a pickem-only site, set the default front page to "pickem"
  58 * For an nfl-pickem site, set the path to custom logo to "pickem/logos.gif" (deprecated) "pickem/random_logo.png" in the 6.x-1.7+
  59 * For an nfl-pickem site, set the path to customer icon to "sites/all/modules/pickem/favicon.ico"
  60
  61 ## Sports Scores Integration
  62
  63 If you want the Sports Scores Module to update the game scores for you, there are a couple steps to perform.
  64
  65 1. pickem gameset sport = sport scores sport.
  66 2. sports scores team names = pickem gameset teams abbrev (OR name).
  67 3. pickem game date = sports scores game date.
  68 4. sports scores game data looks right.  Check out the database and see what is being saved in the sports_scores table.