  ---================---
---   Pogamut v2.3.1    ---
  ---================---
  
A.k.a Pogamut 2 v1.3.1 for NetBeans 6.0.x, 6.1.x

========
WARNING!
========

DO NOT USE WITH NETBEANS 6.5! Or you can, but Posh Syntax highlighting won't work


==========
WHAT'S NEW
==========

1) GB2004
  -- rotation in HRN (hear noise) message fixed
  -- players are exported during handshake (allowing you to provide team-balance feature)

2) PogamutCore
  -- MessageObject.equals() fixed
  -- AgentMemory.getPlayerCount(int team) added allowing you to check how many players are in specific team
  -- Hunter example altered - added team balance feature in case of CTF game

===========================================================================================================  

Contents:
---------

1. introduction 
2. license
3. step-by-step installation of this zip


Contacts:
---------

http://artemis.ms.mff.cuni.cz/pogamut

pogamut@artemis.ms.mff.cuni.cz

---------------
1. INTRODUCTION
---------------

Pogamut 2 is a project aimed at prototyping virtual beings (called agents). It is a platform designed to facilitate creation and debugging of these beings. The principal part is IDE. It is a Netbeans plugin that enables user to code a logic of the agent and then debug it and run it in the virtual environment.
Pogamut 2 is using Unreal Tournament 2004 as an environment for agents. IDE creates agent in the environment, controls it and enables on-the-fly debug, parameter view and modification. User can also confirm agent's behaviour visually or enter the environment with his avatar and interact with agents.

The main objective was to simplify the "physical" part of agent creation. Most actions in the environment (even the complicated ones, like pathfinding and gathering information in agent's memory) can be performed by one or two commands. This enables user to concentrate his efforts on the interesting parts.
Platform also can use external program as a reactive planner for agent. For example, it contains interface to easily link POSH plan and use it as agent's logic.



----------
2. License
----------

The license is bundled with the Pogamut 2 installer as well. Basicly it's saying this...

Do whatever you want with the platform and/or the code as long as you:

    * give us the credit in the work based on Pogamut 2
    * your work is by no means for commercial (or military) purpose or purposes 

Note that the GameBots2004 goes under the different license (BSD).



----------------------------
3. Installation instructions
----------------------------


__ Preconditions __

Installed Unreal Tournament 2004 (version 3369), patch can be downloaded here
http://www.beyondunreal.com/main/ut2004/ut2004essential.php


__ 1 __ 

you will need Sun Java JDK 6

http://java.sun.com/javase/downloads/index.jsp

... note that it is beneficial to leave the ''jusched.exe'' to run at startup and install updates as they are issued


__ 2 __ 

next, download and install NetBeans 6.1

http://download.netbeans.org/netbeans/6.1/final/

Java SE edition should suffice


__ 3 __

Extract this zip into let's say ''c:\temp''

Contents of the zip file (inside directory ''Pogamut_2_NB6_vX.Y.Z''):

[Gamebots]         ... this is containing the files (module) of Gamebots for UT2004 that is needed to be able to run bots inside UT2004

[NetBean6_updates] ... this is containing ''nbm'' files for the NetBeans with Pogamut 2 plugin

[PogamutPlatform]  ... this is directory with the workspace for Pogamut 2 Plugin 


__ 5 __ 

To install Gamebots, you have to do this:
copy contents of directory [Gamebots] into this directory ''UT2004_instalaltion_folder/System'' ... and that's all! :-)


__ 6 __ 

Install NetBeans plugin, to do this:

''A'' Open NetBeans, go to the menu Tools -> Plugins, sheet Downloaded, and search for the button ''Add Plugins...'' (top-left), click it and search for ''nbm'' files previously unziped in ''c:\temp\..'' install all four modules at once.

''B'' copy the [PogamutPlatform] folder from ''c:\temp\...'' somewhere, where you will store your projects (some permanent destination like) ''C:\Program Files\PogamutPlatform''

''C'' set the path to PogamutPlatform folder inside the NetBeans, go to menu Tools -> Options -> Pogamut -> Pogamut base directory (C:\Program Files\PogamutPlatform)


If you have any trubles with installation contact us at pogamut@artemis.ms.mff.cuni.cz