The Archon project consists of a number of general purpose libraries:
| Library | Description |
|---|---|
| Core | Foundational and general purpose utilities |
| Log | General purpose logging |
| CLI | General purpose command line processing |
| Check | General purpose testing framework |
| Math | Vectors and matrices |
| Util | Special purpose utilities |
| Image | Load, save, and manipulate images |
| Font | Font rendering |
| Display | OS GUI integration |
| Render | Facilities for rendering of 3-D graphics |
Here is the list of dependencies for the various libraries of the Archon project:
| Name | Minimum version | Archon library | Optional | Description |
|---|---|---|---|---|
libpng |
1.5.4 | Image | Yes | Image format (Portable Network Graphics) |
| FreeType | Font | Yes | Font rendering facilities | |
| Xlib | Display | Yes | X Window System protocol client library | |
| SDL | 2.0.22 | Display | Yes | OS GUI integration (Simple DirectMedia Layer) |
See below for information on how to install these dependencies on various platforms.
Run this command to install libpng, FreeType, Xlib, and SDL:
apt install libpng-dev libfreetype-dev libx11-dev libsdl2-devRun this command to install libpng, FreeType, and SDL:
brew install libpng freetype sdl2Run this command to install libpng, FreeType, and SDL using Vcpkg:
c:\src\vcpkg\vcpkg.exe install libpng:x64-windows freetype:x64-windows sdl2:x64-windowsIf Vcpkg in not already installed, you can install it by running these commands:
cd c:\src
git clone https://github.com/Microsoft/vcpkg.git
.\vcpkg\bootstrap-vcpkg.bat
.\vcpkg\vcpkg.exe integrate installThe test suite can be built and run through use of CTest (part of CMake). Below are alternative ways of doing it, which offer more control over the testing process.
Enter the root directory of the checked out Archon project, then run this command to build and run the test suite:
bash do.sh check-debugThe check-debug function of do.sh offers a number of useful command line options. To see
them, add --help to the command shown above.
The do.sh shell script offers a number of other functions beyond check-debug. To see a
list of available function, run bash do.sh help.
- Launch Visual Studio.
- Chose "Open a local folder".
- Select the folder holding the checked out Archon project.
- Wait for Visual Studio to finish CMake generation.
- From the "Test" menu, chose "Run CTests for Archon".
Alternatively, after CMake generation has finished:
- Open
src/archon/test.cppinside Visual Studio, and make it the active window. - From the "Debug" menu, chose "Start Without Debugging".
Alternatively, if Git Bash (MinGW-w64) is installed, open Git Bash and enter the root directory of the checked out Archon project, then run:
bash do.sh check-debugSee above for additional possibilities when using do.sh.
Git Bash can be installed from https://gitforwindows.org/.