SOUI 4

Language Versions / 语言版本

This README is available in the following languages:

• English Version (README.md)
• Chinese Version (README.zh-CN.md)

---

Guide

SOUI4 is a lightweight Windows client development framework, continuously developed and maintained for 14 years. The compiled core is about 1MB. The framework design draws inspiration from popular frameworks such as WTL, Android, QT, and Flash. UI presentation is based on XML configuration, with high performance (choose GDI or Skia rendering), rich controls, and flexible extension (supports xml + lua + js), truly separating UI and logic.

Visit the SOUI Official Website.

Demo Screenshots

If you are new to SOUI, you can download the statically compiled demo.exe for a quick try (no need for source code or dependencies, just download and run).

Steps:

1. Click the badge above to enter the page
2. Click any link after the green circle
3. Scroll down to find the Artifacts section
4. Download and extract PC_Demo to run

For more demo cases, visit the DEMO repository:

• https://github.com/soui4-demo Each demo is in a separate repository, clone as needed.

Getting Started

SOUI requires basic knowledge of C++ and Win32. Please ensure you are familiar with these skills. For more details, see the official documentation.

Git Repositories

• GitHub
• Gitee
• GitCode

Build Instructions

Use CMake to generate Visual Studio projects, then compile. All configuration is managed in CMake. For details, see build documentation.

UI Visual Designer

The latest souieditor is integrated in the demos folder. Build the demo to get souieditor.

SOUI4JS

• JavaScript export version for client development. Repository: soui4js
• Supports Windows, Linux, macOS.

SOUI4PY

• Python3 version for client development. Repository: soui4py
• Supports Windows, Linux, macOS.

Tutorials

• Latest Online Tutorial (most complete, updated regularly)
• Tutorial Source Code (host locally with http server)
• Author's Blog
• Author's Bilibili Video Tutorials

QQ Groups

• SOUI Discussion #1: Join
• SOUI Discussion #2: Join

Build Instructions

Windows

• Use CMake to generate project files, open with Visual Studio, and compile
• Or use mingw32/64: mkdir build && cd build && cmake .. && make -j8

Linux

• Pull submodule swinx: git submodule update --init
• Install dependencies: sudo apt install cmake git build-essential gdb libxcb1-dev libgl1-mesa-dev freeglut3-dev
• Build: mkdir build && cd build && cmake .. && make -j8

macOS

• Pull submodule swinx: git submodule update --init
• Install Homebrew (China mirror recommended)
• Install homebrew-core and homebrew-cask: brew tap homebrew/core && brew tap homebrew/cask
• Install tools and dependencies: brew install cmake ninja pkgconf glfw3 glew
• Build: mkdir build && cd build && cmake .. -G Ninja && ninja -j8

Contributors

See contributors.md

License

See license.txt