ACTUAL SCITER VERSION: 3.3.2.5
Windows NuGet:
Linux/MONO/GTK NuGet:
OSX/MONO NuGet:
This library provides bindings of Sciter C/C++ headers to the C# language. Sciter is a multi-platform HTML engine. With this library you can create C#/.NET desktop applications using not just HTML, but all the features of Sciter: CSS3, SVG, scripting, AJAX, <video>, ... Sciter is free for commercial use.
The source is made portable to work in Windows, Linux/GTK+3/Mono and OSX/Mono.
License: GNU GENERAL PUBLIC LICENSE Version 3
Introductory walk-through for writing apps with SciterSharp.
Desktop cross-platform demo app + source-code
Tools:
OmniView - VS extension to preview Sciter HTML content
OmniFiddler - easily edit and share Sciter content
Quick start your desktop app by downloading a Sciter Bootstrap Multi-platform template. The package contains a solution with 3 projects, which you build for Windows with VS, and for Linux and OSX with MonoDevelop. All projects comes with this library already configured and necessary boilterplate code to create a Sciter window and load an initial HTML page.
SciterSharp is available on NuGet.
Windows package:
PM> Install-Package SciterSharpWindows
Linux/GTK+3/Mono package:
PM> Install-Package SciterSharpGTK
OSX/Mono package:
PM> Install-Package SciterSharpOSX
Clone the repository and compile the project for your platform. In your project, add the resulting SciterSharpWindows.dll, SciterSharpGTK.dll or SciterSharpOSX.dll as a reference.
Windows
- >= .NET 4.5
For running you desktop app, you need to make sure that your program can find sciter32/64.dll, so go and grab a copy from Sciter SDK, I don't redistribute it in any form. The best way is to put a copy of each DLL in the bin/Debug/ and bin/Release/ folders or simply add it to Windows PATH, as your prefer.
In Visual Studio, make sure to enable native debugging so you will see Sciter error messages in the Output window: Project Properties / Debug / Check 'Enable native code debugging'
- 64bit distro
- Mono installation
- Install Sciter lib through the install-libsciter.sh script inside the download package
You need to add libsciter-gtk-64.so shared library to your path. The easiest way is to use the download the script from here and run it in a terminal with: sudo bash install-libsciter.sh
The Sciter native library requires the following packages:
- GTK+3:
sudo apt-get install libgtk-3-0 - libcurl: probably already installed in your distro
Sciter have problems with video cards of old computers because the engine by default, is GPU accelerated. For me, in an old notebook I have, the execution hangs when I create the Sciter window. The solution is to switch the graphic engine to non-GPU mode, that is, CPU only. It's possible through the following Sciter API call:
SciterX.API.SciterSetOption(wnd._hwnd, SciterXDef.SCITER_RT_OPTIONS.SCITER_SET_GFX_LAYER,
new IntPtr(SciterXDef.GFX_LAYER.GFX_LAYER_WARP));
--or--
new IntPtr(SciterXDef.GFX_LAYER.GFX_LAYER_GDI));
The API is a complete OO wrap over Sciter C API making things more intuitive and organized. There are 2 namespaces:
SciterSharp - Public main instatiable classes.
SciterSharp.Interop - Internal static classes, PInvoke definitions, Sciter ABI.
Here is a summary of the classes from SciterSharp namespace and their mapping over the official SDK C/C++ headers:
- class SciterWindow: API for creating a native window by PInvoke/SciterCreateWindow(), loading of HTML page via PInvoke/SciterLoadPage(), and message processing via callback for PInvoke/SciterCreateWindow()
- abstract class SciterHost: handling of host notifications generated by Sciter via PInvoke/SciterSetCallback(); attaching of event-handlers; registration of behaviors handlers (behavior factory); call function/eval script; and much more host related things
- class SciterArchive: open an archive from a binary array via PInvoke/SciterOpenArchive() and reading of file via PInvoke/SciterGetArchiveItem()
- class SciterValue: API over Sciter VALUE for manipulating/interfacing with TIScript (JSON data)
- class SciterElement: API over Sciter DOM manipulation (HELEMENT and HNODE) - status: INCOMPLETE: missing node support
- abstract class SciterEventHandler: Sciter event-handler native callback; extend this class for handling Sciter events
- abstract class SciterDebugOutputHandler: API for handling Sciter debug messages; note that by default Sciter output messages to stdout only if SW_ENABLE_DEBUG is set when SciterCreateWindow() is called, so this class usage might be required if you need custom handling/suppress of the output
- class SciterGraphics: API over the Graphics native API - status: 50% COMPLETE
- class SciterRequest: API over the Request native API
With SciterSharp, you can easily create a Sciter child window for you WinForms or WPF application.
There is not yet documentation on how to achieve it, but you can look at the two samples project included in this repo: TestWPF and TestForms.
- add as C# documentation all the helpful API comments found in the official Sciter SDK C headers
- provide an on-line version of the docs from the C# source-code (anyone knows a good tool for automating it?)