yogarine / crayta-stub-generator
Lua stubs for Crayta
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Language:HTML
Requires
- php: >=7
- ext-dom: *
- ext-libxml: *
README
Lua stub generator for the Crayta API Docs.
Crayta is a Free Game Creation Game. Go check it out here: (https://www.crayta.com)
Requirements:
- PHP 7.0 or higher (https://www.php.net/manual/en/install.php)
- Composer (https://getcomposer.org/download/)
- Legendary (https://github.com/derrod/legendary)
Installation
Add this package to your project by running
composer require yogarine/crayta-stub-generator
or install it globally using
composer global require yogarine/crayta-stub-generator
.
Usage
Run vendor/bin/create-crayta-stubs
from your project dir,
or create-crayta-stubs
if installed globally, to generate the stubs. They will
be placed in the stubs
subdirectory of the current working directory.
Development
Updating the LuaDocs xml files (using Legendary)
-
Install and configure Legendary (see https://github.com/derrod/legendary#how-to-runinstall)
- Installation on macOS:
brew install python3.9
pip3 install legendary-gl
- Configuration:
legendary auth
- Installation on macOS:
-
Run
legendary list-games
to get the properapp name
:legendary list-games
The
app name
might be a 32 character hash likea0a49d82e3f64c1b81873397a6e92f09
. -
Install the app with the given app name:
legendary install a0a49d82e3f64c1b81873397a6e92f09
-
Copy over de LuaDocs.
cp -af ~/legendary/Crayta/Crayta/Content/LuaDocs/* LuaDocs/
Disclaimer
This project isn't officially affiliated with Crayta, nor it's developer, Unit 2 Games, in any way. Crayta is a registered trademark and the Crayta stubs and the documentation it includes are Copyrighted by Unit 2 Games. The stubs may be distributed for the promotion of Crayta only, as per Unit 2 Games' Terms of Service.