crown-engine

Lightweight and flexible cross-platform game engine.

##What is it?

It is a general purpose data-driven game engine, written from scratch with a minimalistic and data-oriented design philosophy in mind.

It is loosely inspired by Bitsquid (now Stingray) engine and its design principles; the current Lua API is similar to that of Bitsquid but this engine is not meant to be its clone nor to be API compatible with it.

##Supported platforms

• Android (14+, ARM)
• Linux
• Windows

##Screenshots

TCP/IP console with autocomplete and color-coded output highlighting.

[WIP] Node editor.

##Dependencies

PhysX 3.3.2+ (https://developer.nvidia.com/physx-sdk)

##Building

Getting source

$ git clone https://github.com/taylor001/crown.git
$ cd crown
$ git submodule init
$ git submodule update

Prerequisites

Prerequisites for Android

Android NDK (https://developer.android.com/tools/sdk/ndk/index.html)

$ export ANDROID_NDK_ROOT=<path/to/android_ndk>
$ export ANDROID_NDK_ARM=<path/to/android_ndk_arm>
$ export PHYSX_SDK_ANDROID=<path/to/physx_sdk>

Prerequisites for Linux

$ export PHYSX_SDK_LINUX=<path/to/physx_sdk>

Prerequisites for Windows

GnuWin32 make (http://gnuwin32.sourceforge.net/packages/make.htm)
GnuWin32 coreutils (http://gnuwin32.sourceforge.net/packages/coreutils.htm)
GnuWin32 libiconv (http://gnuwin32.sourceforge.net/packages/libiconv.htm)
GnuWin32 libintl (http://gnuwin32.sourceforge.net/packages/libintl.htm)

$ setx PHYSX_SDK_WINDOWS <path/to/physx_sdk>
$ setx DXSDK_DIR <path/to/dxsdk>

Building

$ make <configuration>

Configuration is <platform>-<debug/development/release>[32|64]. E.g.

linux-debug64, linux-development64, linux-release64, android-debug, windows-debug32 etc.

Documentation

There is pretty extensive documentation for both C++ and Lua API.

Lua API: http://taylor001.github.io/crown/lua_api.html

Prerequisites

Doxygen (http://www.doxygen.org)
Docutils/reStructuredText (http://docutils.sourceforge.net)

Building

$ make docs

##Samples

When running a sample your current directory has to be .build/<platform[32|64]>/bin. To run a sample on 64-bit linux debug mode:

$ ./linux-debug-64 --source-dir <full/sample/path> --bundle-dir <full/destination/path> --compile --platform linux --continue

###01.hello-world

Engine initialization and shutdown.

##Tools

A number of tools can be found at https://github.com/taylor001/crown-tools

Contact

Daniele Bartolini (@aa_dani_bart)

Contributors

In alphabetical order.

Michele Rossi (@mikymod)
Simone Boscaratto (@Xed89)

License

Copyright (c) 2012-2015 Daniele Bartolini and individual contributors.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.