Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qteatime/crochet
Crochet: A tool for creating and remixing interactive experiences, safely.
https://github.com/qteatime/crochet
programming-language secure-by-default
Last synced: 3 months ago
JSON representation
Crochet: A tool for creating and remixing interactive experiences, safely.
- Host: GitHub
- URL: https://github.com/qteatime/crochet
- Owner: qteatime
- License: mit
- Created: 2021-01-06T15:58:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T17:37:40.000Z (11 months ago)
- Last Synced: 2024-06-30T16:52:09.661Z (5 months ago)
- Topics: programming-language, secure-by-default
- Language: TypeScript
- Homepage: https://crochet.qteati.me
- Size: 9.91 MB
- Stars: 126
- Watchers: 7
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Support: support/comby/crochet.json
Awesome Lists containing this project
README
# Crochet
> **NOTE:** Crochet is in early stages of development, there will be a lot
> of breaking changes here as I figure out what kind of language fits the
> games I want to create, and how to generalise that.
Crochet is a tool designed for creating and remixing interactive media safely.
It is best thought as targeting the domains of Interactive Fiction, Simulation
Games, Software Verification, and Interactive/Live Language Tooling.
## Documentation
The documentation books on Crochet are a work in progress, you can find
them in [the Crochet documentation website](https://crochet.qteati.me/docs/).
Currently there's:
- A reference book, which discusses the concepts and design philosophy of Crochet;
- A syntax cheatsheet, which just lists all syntactical forms with examples; and
- A contribution book, which describes how to contribute to Crochet.
## Installing Crochet
For now, you can install Crochet from npm. You want the `@qteatime/crochet`
package with the experimental flag:
```shell
$ npm install @qteatime/crochet@experimental
```
You can also compile it from source:
```shell
$ git clone https://github.com/qteatime/crochet.git
$ cd crochet
$ npm install
$ node make build
```
See `crochet --help` (or `./node_modules/.bin/crochet --help` if you've installed it locally) for usage information.
## Playground
You can try programming interactively with the Playground. You can run with:
```shell
$ crochet playground
```
For node projects you need to specify `node` as your Playground execution
target, since the default is running the package in the browser:
```shell
$ crochet playground --target node
```
You do need to specify a package because that's how Crochet tracks
dependencies and capabilities. All code you type in the Playground will
be executed in the context of the given package. And all dependencies of
that package will be loaded first.
The Playground accepts both declarations and statements/expressions.
## API Reference
You can get a reference documentation page on any package by using the
`docs` command. E.g.:
```shell
$ crochet docs
```
You'll be able to navigate through the documentation by accessing
http://localhost:8080 in your browser.
## Running packages
You can run a Crochet package on the terminal by using the `run` command.
E.g.:
```shell
$ crochet run -- argument1 argument2
```
Anything after `--` is passed as the invocation arguments as-is to your
package. You must provide a command called `main: _`, where the only
parameter will be this list of command line arguments.
Web packages are currently run with the `run-web` command. This does not
accept any invocation arguments:
```shell
$ crochet run-web
```
You can provide a different port with `--port 12345`. Currently the server
is started on port 8000, and Crochet does not try to find an available
port if that one is taken.
## Licence
Copyright (c) 2021 Niini
Licensed under the permissive MIT licence.