README.md

Engine

This is a desktop engine and development interface built for robot control and debugging, using C++, Qt6, and Lua scripting. It is part of the Sysmic Robotics control system.

🧩 Table of Contents

• Installation
• Development Usage
• Production Deployment
• Contributors
• License

---

📥 Installation

git clone https://github.com/Sysmic-Robotics/CondorSSL.git
cd CondorSSL

Follow platform-specific instructions in the setup guide below.

🛠️ Development Usage

Windows

1. Install:

   • MinGW (https://winlibs.com/) Download Linl
   • Qt6 (with SerialPort and WebSockets) Download Link
   • CMake 3.31 (Download Link)
   • VSCode with CMake Tools extension
   • grSim simulator (grSim GitHub)

2. Configure :

   • Add MinGW location to CMake Tools using Configure
   • Add Cmake Path to VSCode Settings
   • Create a build folder inside the project

3. Use the windeployqt program from qt6 installation directory to copy the .dll qt6 files into the build folder Example:

     windeployqt C:\CondorSSL\build\engine.exe

4. Run :

   • Build using CMake Tools
   • Run code by launching the debugger

---

Linux

1. Install:

   • Qt6 (gcc_64 with SerialPort and WebSockets)
   • Lua (e.g. sudo apt install liblua5.3-dev)
   • grSim simulator (grSim GitHub)

2. Build and Run in VSCode:

   • Open Command Palette → CMake: Configure
   • Then: Build → Debug

If Qt6 is not found, manually set the Qt6_DIR using CMake: Edit Cache (UI).

💬 Commands

Command	Description
run <path>	Run a Lua script from the specified path
pause	Pause the currently running script
reload	Reload the last successfully run script
exit	Exit the console reader thread (does not quit app)

Documentation

A brief documentation of the program architecture can be found in docs/architecture. Also there is additional information about Lua functions in the Wiki section of this github repository.

👥 Contributors

📄 License

This project is licensed under the terms of the MIT License.