WebAtlantis Files

Requirements

  Apache with php4 (>=4.0.1), php4-gd, php4-xml.

How to install

  1. Download and unpack WebAtlantis tar-package.
  2. Copy contents of the ./www directory to your web-server.
  3. Create data directory i.e. /var/local/atlantis.
  4. Give write permissions to your data directory, i.e.
                chown www-data /var/local/atlantis
                chmod 700 /var/local/atlantis
  4. Copy contents of the ./server-data directory to the data directory.
  5. Download source code for original Atlantis and compile.
     (There are precompiled linux i386 binaries in Webatlantis-package.
      In that case you do not need to compile it by yourself if you
      don't want to.)
  6. Copy binaries needed (standard and/or wyreth) to your data
     directory.

How to start a game:

  1. Go to the data directory.
  2. Check file 'config' and adjust it if necessary.
  3. Run script ./create_game (if it hangs, press ^C and try again)
  4. Go to the www directory.
  5. Edit file config.php according to your setup.
  6. Add crontab entry for turn prosessing (i.e. /var/local/atlantis/run_game)

Content of the www directory:

  add_form.php      - add new FORM section to the orders file
  add_player.php    - check validity and add given player to the game
  all_graphs.php    - all statistical graphs on one page
  battle.php        - show battle round
  battle_engine.php - collection of html components and calculations for battle
  battle_index.php  - show list of battles
  button.php        - draw a button with text in it
  button2.php       - draw a square-shaped button
  command.php       - order sheet for one unit
  config.php        - game setup, i.e. location of data directory
  del_form.php      - remove FORM section from the orders file
  detail_map.php    - 
  edit.php          - raw text editor for orders
  engine.php        - library of non-graphical functions
  error.php         - show error screen and stop execution of the script
  faction.php       - faction spesific commands
  flag.php          - draw a flag
  graphics.php      - library of graphical functions  
  html.php          - library of html components, i.e. menu bars etc.
  index.php         - starting page
  join.php          - join the game screen
  login.php         - check game status and decide next screen after authentication  
  logout.php        -
  main_map.php      - first screen
  map.php           - full sized map
  motd              - message of the day
  nexus.php         - game screen for the first turn
  nexus_map.php     - map of the first turn
  one_hex_map.php   - small map containing only one hex
  orders.php        - libary for orders handling
  region.php        - weather, production etc. maps
  report_dump.php   - for debugging
  send_orders.php   - parse environment varibles and update orders for current turn
  setup.php         - get contents of players.in file
  stats_engine.php  - common functions for statistics display
  stats.php         - visible statistics page
  tables.php        - miscellanous tables
  tactical_map.php  - region map (people, wages, products, etc)
  text_report.php   - old fashioned text report
  thankyou.php      - screen after succesful join
  unit.php          -

Content of the data directory:

  atlantis          - game engine itself
  atlantis.log.N    - output of processing of turn N
  backup/           - backups of old turns
  config            - configuration of the game
  create_game       - this script starts new game
  game.in           - Atlantis game data
  handle_report     - Report processing script
  kill_game         - remove all game files
  orders.N          - orders for this turn given by player N
  players.in        - Atlantis player data
  players.in.N      - player data of the turn N
  report_to_xml.pl  - convert report to XML
  restore_backup    - find last valid backup and restore it
  run_game          - run Atlantis turn
  statistics.N.html - statistics of turn N (generated each time, when turn is accessed first time)
  status.N          - personal configuration file for player N