Arcan开源项目教程

Arcan开源项目教程

arcan Arcan - [Display Server, Multimedia Framework, Game Engine] -> "Desktop Engine" 项目地址: https://gitcode.com/gh_mirrors/ar/arcan

1. 项目介绍

Arcan是一个强大的开发框架，用于创建从专业嵌入式应用的用户界面到完整的独立桌面环境等各种项目。它的核心是一个健壮且可移植的多媒体引擎，拥有经过良好测试和文档化的Lua脚本接口。开发重点放在安全性、可调试性和性能上，API设计遵循最小惊讶原则。

2. 项目快速启动

环境准备

首先，确保您的系统中安装了以下依赖项（具体的包名取决于您的发行版）：

• sqlite3
• openal-soft
• sdl2
• opengl
• luajit
• gbm
• kms
• freetype
• harfbuzz
• libxkbcommon

如果您需要更多的编解码支持，也可能需要以下库：

• libvlc-core (videolan)
• ffmpeg套件
• leptonica + tesseract (ocr)
• libvncserver
• libusb1
• v4l2-loopback
• mupdf

克隆项目

从GitHub克隆Arcan项目：

git clone https://github.com/letoram/arcan.git
cd arcan/external/git
./clone.sh
cd ../../

编译

创建一个构建目录并配置构建系统：

mkdir build
cd build
cmake -DBUILD_PRESET="everything" ../src

您可以通过添加 -DCMAKE_BUILD_TYPE=Debug 来切换到调试构建。

完成依赖项探测后，您将得到一个报告，显示已找到的依赖项和启用的功能，或者如果有任何必需的依赖项未找到，将会警告您。

按照正常流程编译和安装（即 make 和 sudo make install）。

运行

要测试“在源代码中”（不安装），您应该能够运行以下命令：

./arcan -T ../data/scripts -p ../data/resources ../data/appl/welcome

这里，-T 参数设置内置/共享的脚本集，-p 指定共享资源（如字体）的位置，最后一个参数是要运行的实际“脚本”。

安装后，这应该简化为：

arcan welcome

它将自动尝试确定是否应该作为原生显示服务器运行，或者在另一个或它自身内部嵌套运行，这取决于各种环境变量（DISPLAY, WAYLAND_DISPLAY, ARCAN_CONNPATH）的存在。

'welcome' 是一个简单的内置欢迎屏幕，将在几秒后自动关闭。

对于更直接有用的东西，您可以尝试内置的 'console' 应用：

arcan console

它应该会像您的正常控制台命令行一样工作，但增加了能运行（与arcan兼容的）图形应用的能力。

如果输入设备行为不正常，位于 arcan /path/to/arcan/tests/interactive/eventtest 的 eventtest 可能有助于找出责任所在。

3. 应用案例和最佳实践

• 案例一：使用Arcan创建一个简单的图形用户界面。
• 案例二：利用Arcan的多媒体引擎功能开发一个游戏。

4. 典型生态项目

Arcan生态系统中有许多相关的项目，例如：

• Arcan-net：允许您通过网络转发一个或多个arcan客户端。
• Arcan-wayland（或waybridge）：添加对wayland和X客户端的支持。

这些项目可以通过Arcan的核心功能进行扩展，以满足不同的开发需求。

arcan Arcan - [Display Server, Multimedia Framework, Game Engine] -> "Desktop Engine" 项目地址: https://gitcode.com/gh_mirrors/ar/arcan