IrrConsole - a Quake Style Drop Down console for Irrlicht Engine
[ home | docs | gallery | download | credits | links ]
IrrConsole

This component provides a Quake Style Drop down console where log messages may be viewed and commands typed. You can browse the documentation or view the galleryor download the binary or source for a trial run.

This is a part of the M_TRIX Project.

This is licensed under the ZLib/LibPNG license

IrrConsole::Docs::Installation Guide

  1. Download the IrrConsole Demo binary archive file
  2. Extract it to somewhere on the System. We shall call this directory <ICRoot>
  3. Make Sure Irrlicht.DLL version 0.7.1 is in the system path or copy the dll into the directory.
  4. Now this should work by double clicking on the TestApp.exe, but if you want the Quake III map loading go to the irrlicht media directory on the Irrlicht SDK and copy the PK3 file named "map-20kdm2.pk3" and copy it to a folder called "pak" under "data"

    [NOTE: If you do not copy the PK3 file then you can not use the "\show_node level" command. I skipped this as it is big file.]

  5. now fire up the demo and type ~ to bring down the console.
  6. type "\list" to see a list of supported commands
  7. remember the commands have to be preceded by "\" to execute else the console just echoes whatever was typed.
  8. for details about supported commands, see the Demo Documentation

IrrConsole::Docs::API Documentation

You can either browse the Doxygen generated API documentation for the IrrConsole framework and demo or download the same from the downloads section.

IrrConsole::Docs::Demo Documentation

The IrrConsole TestApp is a simple demo to show how easy it is to integrate into the IrrConsole framework. The Demo TestApp code is supplied in the source code archive pay special attention to the code in TestApp::OnEvent() and the TestApp::init() code. The TestApp::run() also shows how easy it is to render the console.

For a detailed description see the API documentation.

IrrConsole::Docs::Developer's Guide

A Developer's Guide and Tutorial is under progress for the IrrConsole library. It shall be made available as soon as it is complete


[ home | docs | gallery | download | credits | links ]
Copyright © 2004 Saurav Mohapatra. All Rights Reserved.