Crafty.js HTML5 game engine components directory.
Maintained by Giovanni Cappellotto.
To get your component listed at http://craftycomponents.com create a component.json file at project's root following the standard described below and add a webhook in your repository to http://craftycomponents.com/hooks/github.
This section is all you need to know about what's required in your component.json file. It must be actual JSON, not just a JavaScript object literal.
This section is an abridged version of the npm package.json specification.
The most important things in your component.json are the name and version fields. They are actually required. The name and version together form an identifier that is assumed to be completely unique. Changes to the package should come along with changes to the version.
The most important things in your component.json are the name and version fields. They are actually required. The name and version together form an identifier that is assumed to be completely unique. Changes to the package should come along with changes to the version.
Version must be parseable by node-semver, which is bundled with npm as a dependency. (npm install semver to use it yourself.)
Put a description in it. It's a string. This helps people discover your component.
Put keywords in it. It's an array of strings. This helps people discover your component.
The url to the project homepage.
The author is one person. A person is an object with a name field and optionally url and email, like this:
{
"author": {
"name": "John Doe",
"email": "[email protected]",
"url": "http://example.com/"
}
}You should specify a license for your component so that people know how they are permitted to use it, and any restrictions you're placing on it.
The simplest way, assuming you're using a common license such as BSD-3-Clause or MIT, is to just specify the standard SPDX ID of the license you're using, like this:
{ "license": "BSD-3-Clause" }You can check the full list of SPDX license IDs. Ideally you should pick one that is OSI approved.
If you have more complex licensing terms, or you want to provide more detail in your component.json file, you can use the more verbose plural form, like this:
{
"licenses": [
{
"type": "MyLicense",
"url": "http://github.com/owner/project/path/to/license"
}
]
}It's also a good idea to include a license file at the top level in your package.
Specify the place where your code lives. This is helpful for people who want to contribute.
Example:
{
"repository": {
"type": "git",
"url": "http://github.com/owner/project.git"
}
}