submit a preset

This page covers how you can submit a new preset for be for everyone to enjoy.

preset metadata

In addition, all presets must contain a package.json with metadata about the preset, primarily it's "type" and "schema" version (don't worry, you can just copy the example below), but also which specific files to include from this preset when creating a new project.

package.json example

{
    "schema_version" : "0.0.1",
    "type" : "bepreset",
    "label": "My Nice Name",
    "description": "A generic project configuration",
    "thumbnail": "thumbnail.png",
    "link": "https://github.com/mottosso/be-ad"
}

preset contents

Unless specified, be will include the default files listed under anatomy of a preset. You can specify the exact contents of a preset via the contents key of your package.json.

{
    "schema_version" : "0.0.1",
    "type" : "bepreset",
    "contents": [
        "inventory.yaml",
        "mydatafile.bin",
        "custom_directory"
    ]
}

This allows your to include additional files with a preset, such as fixtures or even getting-started material such as images, 3d models or sound.

submit a preset

Presets are registered as their username/repo combination, e.g. mottosso/be-ad.

1. Fork this repository
2. Add your repository to presets.json
3. Submit a pull-request

Your preset, once merged, will then be available via be.

$ be new mypreset

presets.json example

{
    "schema_version": "0.1.0",
    "presets": [
        {
            "name": "ad",
            "repository": "mottosso/be-ad"
        },
        {
            "name": "mypreset",
            "repository": "myuser/be-mypreset"
        }
   ]
}

you're done

Once your preset has been accepted into be-presets, the online database is updated about once every half-hour. Once some time has passed, you and everyone be able to see and use it!