Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/florentpoujol/daneel

A framework for CraftStudio that bring new functionalities, extend and render more flexible to use the API as well as sweeten and shorten the code you write.
https://github.com/florentpoujol/daneel

Last synced: 1 day ago
JSON representation

A framework for CraftStudio that bring new functionalities, extend and render more flexible to use the API as well as sweeten and shorten the code you write.

Host: GitHub
URL: https://github.com/florentpoujol/daneel
Owner: florentpoujol
Created: 2013-02-01T13:40:51.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2015-05-31T10:10:28.000Z (over 9 years ago)
Last Synced: 2023-03-24T07:43:03.376Z (almost 2 years ago)
Language: Lua
Homepage: https://static.florentpoujol.fr/daneel
Size: 9.18 MB
Stars: 8
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

[craftstudio]: http://craftstud.io

# Daneel

Daneel is a scripting framework written in [Lua](http://www.lua.org) for [CraftStudio][] that bring new functionalities, extend and render more flexible to use the API as well as sweeten and shorten the code you write.

_Since May 2015, the development of CraftStudio is discontinued after its last big release (client v1.7.0) and so is the development of Daneel after v1.5.0._

## Documentation

[http://daneel.florentpoujol.fr/docs](http://daneel.florentpoujol.fr/docs)

Setup instructions : http://daneel.florentpoujol.fr/docs/setup

## Support

If you have got any trouble or question, [leave a support ticket on GitHub](https://github.com/florentpoujol/Daneel), or contact me :

- [email protected]
- [@FlorentPoujol](https://twitter.com/FlorentPoujol)

Or leave a support topic in CraftStudio's community forums :

- [English forum](http://www.craftstudioforums.net/index.php?forums/help-with-scripting.30)
- [French forum](http://www.craftstudio.fr/forum/viewforum.php?f=4)

## Licence

Daneel is published under the MIT license.

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.

## Repo structure

The main `.lua` files are in the `src` folder.
The scripts at the root of the folder are 'global' and don't need to be added as scripted behavior on game objects (contrary to the one found in the `scripted behaviors` folder).

The `build/Daneel.lua` script (and its minified version) is an aggregation of all the 'global' scripts at the root of the `src` folder.

The `docs` folder contains the documentation website.
The actual documentation content is in the `docs/files` folder.