README

Codebot Cross Platform Library

This is the official git repository for the Codebot Cross library. It contains the source code and assets for a set of Free Pascal and Lazarus packages. It has been updated to work with the Lazarus GTK3 widgetset.

The official landing page for the library, with detailed information including installation, documentation, and examples, is located here. A tour of every package is in source/packages.txt.

Package Codebot

The Codebot package defines types and routines for general purpose use. These include items such as string and file system handling, collections, advanced graphics contexts, network sockets, animation, and much more.

Package Codebot Controls

The Codebot Controls package defines classes and routines related to visual controls. Many of these controls are original, unique, and all make use of the advanced ISurface cross platform drawing context provided by the Codebot package. Some of the controls in this package include TContentGrid, TIndeterminateProgress, THuePicker and more. Custom forms and custom IDE designers are also included in this package.

Package Codebot Render

The Codebot Render package provides an organized and easy to use class library for working with OpenGL and OpenGL ES, shader programming, vertex, render, and pixel buffers, as well as 2D physics, audio, and input processing. Scenes can be hosted inside an LCL form with codebot_render_controls, or in an SDL window with codebot_render_sdl.

Package Codebot Terminal

The Codebot Terminal package defines TTerminal, a terminal emulator control which runs the user's shell inside a form.

Package Codebot WebKit

The Codebot WebKit package defines TWebBrowser, a web browser control with an address bar and a status indicator.

Installation

The scripts folder contains installers which set up the Free Pascal compiler, the Lazarus IDE, this library, its dependencies, and optionally the demo projects.

On Windows, run the installer in PowerShell with:

irm https://www.getlazarus.org/install-win.ps1 | iex

On Linux, run the installer as your normal user, not as root. It asks for administrator access only when packages need installing.

Dependencies

The core codebot and codebot_controls packages need only the essential libraries. OpenGL rendering, the web browser, and the terminal each need extra libraries.

Installing only the dependencies

If you already have Free Pascal and Lazarus, use the scripts in scripts/dependencies. Run them from the repository root, as your normal user.

Linux:

bash scripts/dependencies/install-linux.sh

Raspberry Pi:

bash scripts/dependencies/install-raspberrypi.sh

Windows (PowerShell):

powershell -ExecutionPolicy Bypass -File scripts\dependencies\install-win.ps1

Linux

Essential:

Optional features:

Without libmpv, disable video by changing {$define videowidget} to {.$define videowidget} in source/codebot_render/render.inc.

Raspberry Pi

build-essential libsdl2-dev libsdl2-image-dev libassimp-dev libxml2-dev libmpv-dev libssl-dev
libgl1-mesa-dev libglu1-mesa-dev libegl1-mesa-dev libgles2-mesa-dev

Windows

DLLs, installed into %LOCALAPPDATA%\bin:

The terminal control (VTE) is not available on Windows and as a result it has no dependency on Windows.