https://github.com/thebest12dev/cinnamontoast
A framework with an easy learning curve
https://github.com/thebest12dev/cinnamontoast
cmake cpp20 luajit mit openssl tinyxml2 vcpkg
Last synced: 6 months ago
JSON representation
A framework with an easy learning curve
- Host: GitHub
- URL: https://github.com/thebest12dev/cinnamontoast
- Owner: thebest12dev
- License: mit
- Created: 2025-03-20T05:43:44.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-26T11:38:11.000Z (6 months ago)
- Last Synced: 2025-04-26T12:34:24.012Z (6 months ago)
- Topics: cmake, cpp20, luajit, mit, openssl, tinyxml2, vcpkg
- Language: C++
- Homepage:
- Size: 890 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Project "CinnamonToast"
Project CinnamonToast (as referred by it's codename) is a project that creates a cross-platform UI framework that's fast, modern and easy to work with. It's based on .xml and shared library files, separating the declaration from the definition. as well as an IDE (CinnamonToast IDE) written in .NET.
Since the codebase is all written in C++, for a more user-friendly approach, we'll be using a custom IDE with support for drag-and-drop elements (like Visual Studio Designer) and also support for Lua, as an external library though this may add extra overhead to the codebase.
Currently, since its a very early project, there are still a TON of problems (like memory leaks, performance issues or UI issues) that will be addressed in the future.
## Creating a program
To create a simple GUI, you can directly modify the .xml files, but you can use the IDE for convenience.
Example:
```xml
Hello, world!
```
For the implementation (written in Lua), insert:
```lua
-- main.lua
print("Loaded!")
local label = CinnamonToast.getComponentById("label1")
print(label.getText())
```
or you can directly use C++ (faster, but more complicated):
```cpp
#include // CinnamonToast API
#include
#include
#include
extern "C" __declspec(dllexport) void CToastMain(CinnamonToast::CToastAPI* api) {
std::cout << "Loaded!" << std::endl;
CinnamonToast::ComponentId id = api->GetComponentById("label1");
const char* string = api->GetComponentText(id);
std::cout << string << std::endl;
};
```
## Building
To build CinnamonToast, you need CMake and a C++ compiler (like MSVC, or g++). Then simply do these steps:
### If using Visual Studio IDE
1. Open the project in Visual Studio
2. Select the configuration (Debug or Release)
3. Select ctoasti.exe as the target
4. Finally, build the project (as it will be automatically be built)
### If using plain CMake and VS Build Tools
1. Open a terminal
2. Navigate to the project directory
3. Run `python3 DownloadLibraries.py` to download the libraries source (like tinyxml2)
4. If you're using MSBuild, run
```cmd
cmake -G "Visual Studio xx xxxx" -A x64
```
If you're using Ninja, run
```cmd
cmake -G "Ninja" -DCMAKE_TOOLCHAIN_FILE=path/to/vcpkg/cmake -DTRIPLET=x64-windows"
```
5. Now, build the project
```cmd
cmake --build . --config Release
```
### If building on Linux
1. Open a terminal
2. Install CMake and g++ if you haven't already: `sudo apt install cmake g++ ninja-build`
3. Navigate to the project directory
5. Run `cmake . -G "Ninja" -DCMAKE_TOOLCHAIN_FILE= -DTRIPLET=x64-linux`
6. Run `ninja`
This will build the project and create the launcher (ctoasti) as well as the shared libraries (CinnamonToast.Core, etc.) that you can link with your projects.
## Security and sandboxing
For native code, there isn't any sandboxing, so beware of malicious programs.
For Lua, it's fully sandboxed, so it won't be able to access the filesystem or any other system resources. It can only access the CinnamonToast API and the Lua standard library.