CraftyComponents/README.md at master · craftyjs/CraftyComponents · GitHub
Skip to content
Navigation Menu
Sign in Appearance settings
* Platform
* AI CODE CREATION
* GitHub Copilot Write better code with AI
* GitHub Copilot app Direct agents from issue to merge
* MCP Registry Integrate external tools
* DEVELOPER WORKFLOWS
* Actions Automate any workflow
* Codespaces Instant dev environments
* Issues Plan and track work
* Code Review Manage code changes
* Code Quality Enforce quality at merge
* APPLICATION SECURITY
* GitHub Advanced Security Find and fix vulnerabilities
* Code security Secure your code as you build
* Secret protection Stop leaks before they start
* EXPLORE
* Why GitHub
* Documentation
* Blog
* Changelog
* Marketplace
View all features
* Solutions
* BY COMPANY SIZE
* Enterprises
* Small and medium teams
* Startups
* Nonprofits
* BY USE CASE
* App Modernization
* DevSecOps
* DevOps
* CI/CD
* View all use cases
* BY INDUSTRY
* Healthcare
* Financial services
* Manufacturing
* Government
* View all industries
View all solutions
* Resources
* EXPLORE BY TOPIC
* AI
* Software Development
* DevOps
* Security
* View all topics
* EXPLORE BY TYPE
* Customer stories
* Events & webinars
* Ebooks & reports
* Business insights
* GitHub Skills
* SUPPORT & SERVICES
* Documentation
* Customer support
* Community forum
* Trust center
* Partners
View all resources
* Open Source
* COMMUNITY
* GitHub Sponsors Fund open source developers
* PROGRAMS
* Security Lab
* Maintainer Community
* GitHub Stars
* Archive Program
* REPOSITORIES
* Topics
* Trending
* Collections
* Enterprise
* ENTERPRISE SOLUTIONS
* Enterprise platform AI-powered developer platform
* AVAILABLE ADD-ONS
* GitHub Advanced Security Enterprise-grade security features
* Copilot for Business Enterprise-grade AI features
* Premium Support Enterprise-grade 24/7 support
* Pricing
Search /
Sign in
Sign up Appearance settings
You signed in with another tab or window. Reload to refresh your session.
You signed out in another tab or window. Reload to refresh your session.
You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
Uh oh!
There was an error while loading. Please reload this page .
craftyjs
/
CraftyComponents
Public
*
Notifications
You must be signed in to change notification settings
*
Fork
6
*
Star
7
*
Code
*
Issues
3
*
Pull requests
0
*
Actions
*
Projects
*
Wiki
*
Security and quality
0
*
Insights
Additional navigation options
*
Code
*
Issues
*
Pull requests
*
Actions
*
Projects
*
Wiki
*
Security and quality
*
Insights
Files Expand file tree
master
Breadcrumbs
* CraftyComponents
/ README.md
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
93 lines (60 loc) · 3.05 KB
master
Breadcrumbs
* CraftyComponents
/ README.md
Copy path
Top
File metadata and controls
* Preview
* Code
* Blame
93 lines (60 loc) · 3.05 KB
Raw
Copy raw file
Download raw file
Outline Edit and raw actions
CraftyComponents
Crafty.js HTML5 game engine components directory.
Maintained by Giovanni Cappellotto .
How does it work
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 .
component.json
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.
name
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
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.)
description
Put a description in it. It's a string. This helps people discover your component.
keywords
Put keywords in it. It's an array of strings. This helps people discover your component.
homepage
The url to the project homepage.
author
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/ "
}
}
license
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.
repository
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 "
}
}
Footer
(c) 2026 GitHub, Inc.
Footer navigation
*
Terms
*
Privacy
*
Security
*
Status
*
Community
*
Docs
*
Contact
*
Manage cookies
*
Do not share my personal information
You can’t perform that action at this time.