https://github.com/vcync/frameV

Framed Visuals: collaborative generative art.
https://github.com/vcync/frameV

art canvas2d collaborative generative-art svg webgl

Last synced: about 2 months ago
JSON representation

Framed Visuals: collaborative generative art.

• Host: GitHub
• URL: https://github.com/vcync/frameV
• Owner: vcync
• Archived: true
• Created: 2020-04-28T08:40:53.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2023-01-12T12:21:38.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T02:33:17.816Z (5 months ago)
• Topics: art, canvas2d, collaborative, generative-art, svg, webgl
• Language: JavaScript
• Homepage: https://framev.vcync.gl/
• Size: 401 KB
• Stars: 22
• Watchers: 5
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# frameV

Framed Visuals: collaborative generative art.

## What is frameV?

frameV is a collaborative platform to display artworks that are rendered in the browser.

It is open source and anybody can submit their work.

The works are randomly selected from a pre-approved list and refreshes currently every 60 seconds.

## Why the browser?

The web is open, accessible, and runs everywhere.

You want to run this on your old phone as a cool art display in your house? No problem.

## What is the approval process?

Submit a PR following the steps below.

Maintainers will run your work, make sure it isn't malicious and you'll most likely get your work shown.

If there is a problem, we'll let you know via your PR.

## Adding a work to frameV

1. Create your repo

   * Your repo should have an `index.html` file in the root. An example of a frameV repo can be found here: https://github.com/2xAA/frame-v-squares

   * You can use any method to create animations (SVG, Canvas2D, WebGL etc) but be wary that not everyone's devices will be the same, so performance counts.

   * frameV will make the root of your repo available at `framev.vcync.gl/` when your work is displayed. However, if you have set the `dir` key on your work entry, the directory in _your_ repo specified with `dir` will be available at `framev.vcync.gl/` instead.

2. Fork this repo

3. Add a work entry in `works.json` (see the [Work entries](#work-entries) section below for more info)

4. Create a PR back to this repo

## Work entries

The `works.json` file contains an array of work entries in the following format:

```javascript

{

  "author": "2xAA",

  "title": "Squares",

  "repo": "https://github.com/2xAA/frame-v-squares",

  "dir": "dist" // (optional)

}

```

### Dir

The `dir` key is optional and is used to specify where in *your* repo your index.html is.

An example of a working repo with the `dir` key specified in the work entry can be found here: https://github.com/2xAA/framev-unicode-wave

## Requirements for running the server

* node.js >= 12

## Running the server

1. Clone this repo

2. `yarn`

3. `node index.js`