Table of Contents

Downloads

The latest version of Sqrat can be downloaded from SourceForge

Current stable version: 0.8.3

Sqrat sources are hosted in a Sourceforge git repository. See https://sourceforge.net/p/scrat/code/ci/master/tree/ for access information.

Bug Reporting

Bug reports or feature enhancement requests and patches can be submitted at the SourceForge Sqrat site

Introduction

Sqrat is a C++ library for Squirrel that facilitates exposing classes and other native functionality to Squirrel scripts. It is similar to SqPlus, both in functionality and syntax, but seeks to address several issues present in other binding libraries.

Sqrat models the underlying Squirrel API a little more closely than most other binding utilities, and this fact gives it a lot of power in exchange for a couple of minor quirks in the syntax. Code is straightforward and easy to read, however, and can easily be ported to from existing bindings.

Beginning in Sqrat 0.8, several utilitiy libraries are also included to extend the squirrel language itself with useful libraries and functionalities.

Sqrat has been tested against Squirrel 2.1.1 through 2.2.3 and 3.0 to 3.0.4. Other versions may work fine, but the author makes no promises!

The current development branch (to become Sqrat 0.9 or 1.0) has new futures, the major additions being parameter type and number checking. This branch will become Sqrat 0.9

NEW! Documentation for Sqrat 0.9

Features

License

Sqrat is licensed under the zlib/libpng license:

	Copyright (c) 2009 Brandon Jones
	
	This software is provided 'as-is', without any express or implied
	warranty. In no event will the authors be held liable for any damages
	arising from the use of this software.
	
	Permission is granted to anyone to use this software for any purpose,
	including commercial applications, and to alter it and redistribute it
	freely, subject to the following restrictions:
	
	1. The origin of this software must not be misrepresented; you must not
	claim that you wrote the original software. If you use this software
	in a product, an acknowledgment in the product documentation would be
	appreciated but is not required.
	
	2. Altered source versions must be plainly marked as such, and must not be
	misrepresented as being the original software.
	
	3. This notice may not be removed or altered from any source
	distribution.
	

What this means in plain English is essentially that you are welcome to do anything you want with the code for any purpose, but cannot claim that you wrote the library. Also, any time you redistribute the source, the license must be attached to it.

As far as giving credit goes: I personally don't care if you give me credit or not when you use Sqrat, but I would love to hear about projects that it's used in!

Contact Information

Brandon Jones (Toji) - tojiro (at) gmail (dot) com
Andy Tai - atai (at) atai (dor) org
Brandon Haffen AKA Wizzard - bhaffen97 (at) gmail (dot) com