OpenXTalk Community Edition

OpenXTalk is derived from legacy LiveCode Community Edition code base that is Copyright © 2003-2019 LiveCode Ltd., Edinburgh, UK

Introduction

The OpenXTalk Community open source platform provides a way to build applications for mobile, desktop and server platforms.

Overview

Subproject directories

This repository contains a number of subprojects, each of which has its own subdirectory. They can be divided into three main categories.

1. Main system:

• engine/ — The main OpenXTalk engine. This directory produces the IDE, "standalone", "installer" and "server" engines

2. Non-third-party libraries:

• libcore/ — A static library that provides various basic functions and types, and is used by many of the other subprojects

• libexternal/ and libexternalv1 — Static libraries that support the OpenXTalk "external" interface, which allows the engine to load plugins

3. Externals (libraries that can be dynamically loaded into the engine at runtime):

• revdb/ — Database access external, and drivers for various backend database systems

• revmobile/ — The iOS support external (which can only be built on Mac) and the Android support external (available on all desktop platforms)

• revpdfprinter/ — Print-to-PDF functionality

• revspeech/ — Text-to-speech support

• revvideograbber/ — Video capture (Windows only)

• revxml/ — XML parsing and generation

• revzip/ - Zip archive management

Engine flavours

The engine — which loads, saves, manages and runs OpenXTalk stack files — can be built in several different specialized modes, which are adapted for various specific purposes. They are exposed as separate targets in the build system.

1. IDE engine (development target)— Used to run the IDE. It contains extra support for things like syntax handling and building OpenXTalk "standalone" programs.

2. Installer engine (installer target) — Used to create the OpenXTalk installer. It contains extra support for things like handling zip archives and comparing binary files.

3. Server engine (server target) — This is the engine used in a server context, when no graphical user interface is needed. It contains server-specific functions such as CGI support. It also has a much fewer system library dependencies (and requires only non-desktop APIs where possible).

4. Standalone engine (standalone target) — The engine that is embedded in "standalone apps" created with OpenXTalk.

Compiling OpenXTalk

OpenXTalk uses the gyp (Generate Your Projects) tool to generate platform-specific project files. It can generate xcodeproj files for Xcode on Mac, vcproj files for Microsoft Visual Studio, and makefiles for compiling on Linux.

Quick start

Note: You can only compile OpenXTalk from a clone of the OpenXTalk-DPE git repository on GitHub. See also the GitHub documentation on cloning a repository.

On Linux or Mac, you can quickly build OpenXTalk by installing basic development tools, and then running make all.

Detailed instructions

Please see the following table, which shows which target platforms are supported by which host platforms. The documentation for compiling for each target platform is linked.

Target platform	Host platforms
mac, ios	mac
win	win, linux (Wine)
linux	linux
android	mac, linux
emscripten (html5)	linux

Getting help and Gifting Help

For help with installing and using OpenXTalk or if you have discovered a bug, have a feature request, or have written a patch to improve OpenXTalk, drop by in and join the fun https://forums.openxtalk.org/:

• Visit the OpenXTalk open source forums.

Contributing to OpenXTalk

For information on modifying OpenXTalk and submitting contributions to the OpenXTalk Community project, please see the CONTRIBUTING file.

License

OpenXTalk Community is freely distributable under the GNU Public License (GPL3), with some special exceptions.

For more information, please see the LICENSE file in this repository.

The OpenXTalk Community engine, libraries, and associated files are, unless otherwise noted: Copyright © 2003-2019 LiveCode Ltd.