
    Welcome to PSPIRC


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

  PSPIRC is a basic IRC client for the PSP. It is based on the IRC engine
  written by Danzel.

  Many thanks to Danzel for his Virtual kerboard and his IRC stuff, 
  and to all PSPSDK developpers.

  Special thanks to Snaap06 for EBOOT icons.

  This software is distributed under GNU V2 License, see GPLV2.txt file 
  for all details and information about it.

2. INSTALLATION
   ------------

  Unzip the zip file, and copy the content of the directory fw1.5 or fw3.x
  (depending of the version of your firmware) on the psp/game, or psp/game340
  if you use custom firmware 3.40-OE.

  It has been developped on linux using Firmware 3.40-OE.

  For any comments or questions on this version, please visit 
  http://zx81.zx81.free.fr, http://www.dcemu.co.uk, or 
  http://pspupdates.qj.net

3. CONTROL
   ------------

3.1 - Virtual keyboard

  In the console window, press Start to open/close the 
  On-Screen keyboard

  The On-Screen Keyboard of "Danzel" and "Jeff Chen"

  Use Analog stick to choose one of the 9 squares, and
  use Triangle, Square, Cross and Circle to choose one
  of the 4 letters of the highlighted square.

3.2 - IR keyboard

  You can also use IR keyboard. Edit the pspirkeyb.ini file
  to specify your IR keyboard model, and modify eventually
  layout keyboard files in the keymap directory.

  The following mapping is done :

  IR-keyboard   PSP

  Cursor        Digital Pad

  Tab           Start
  Ctrl-W        Start

  Escape        Select
  Ctrl-Q        Select

  Ctrl-E        Triangle
  Ctrl-X        Cross
  Ctrl-S        Square
  Ctrl-F        Circle
  Ctrl-Z        L-trigger
  Ctrl-C        R-trigger

  Ctrl-L        Clear


4. HOW DOES-IT WORK ?
   ------------

4.1 - Create a connection with host, user, channel :
 
  Host: name of the IRC server
  Port: by default it's set to 6667, which is the standard IRC port but you can
        change it.
  User: user name for this connection 
  Nick: nickname for this connection 
  Real: realname for this connection 
  Chan: channel name for this connection 
  Pass: password (optional) for this connection


  The channel name should begin with a # for example:
    #psp
  You can specify more than one channel:
    #psp#etc

  All those parameters can be easily entered using the Virtual Keyboard (Press
  Start to display the keyboard).

  You can save your parameters in a binary encoded file if you want using the
  "Save profiles" menu.

4.2 - Connect to the IRC server

  Then you can connect to the host you've specified using the
  "Connect" menu.

  If everything is going right, you should see a console with
  a prompt few seconds after.

4.3 - Enter commands in the console window

  In the console window you can use the Virtual Keyboard to
  enter text or IRC commands.

  The D-pad is mapped as follows :

    Up    : /
    Down  : <ENTER>
    Left  : <Backspace>
    Right : <Space>

  Using Analog pad you can scroll the console window.  Using the start button
  you can use the Virtual keyboard. Using LTrigger and RTrigger keys you can
  navigate through the different opened channels.

  Press the Select key to enter in the Console menu.  You will then be able to
  choose IRC commands, or common words in a list. 

  Use the Virtual Keyboard to specify the first letter of the command or the
  word (using letters panel).

  All those commands and words are written in a file (respectively command.txt
  and word.txt) that can be edited using your favorite ASCII-text editor, and
  you can add your own custom commands and words.

  (NOTE) All commands and words should be alphabetically sorted !

  When you enter commands you can use the Users menu to paste a user name
  present in the current channel.  In the same maner, you can enter in the
  Channels menu to paste the name of a channel you have joined.

  The "Join channel" menu will display all the channels available on the
  server you are connected on.  You may need to refresh the list.

  The "Users" menu can be used to write private message to a given user. It
  opens a new tab with this private discussion. 


5. Save snapshots and log files
   ------------

  You can save snapshot in PNG format using the snapshot option.
  Files would be saved in the scr directory.

  You can also save the IRC console window as a text file.
  Files would be saved in the log directory.
  

6. COMPILATION
   ------------

  It has been developped under Linux using gcc with PSPSDK. 
  To rebuild the homebrew run the Makefile in the src archive.

