Skip to content
/ v-place Public

v-place a digital canvas where artist collaborate to create art heavily inspired by r/place

License

Notifications You must be signed in to change notification settings

v4zha/v-place

Repository files navigation

v-place

v/place is a digital canvas where users can collaborate to create pixel art heavily inspired by r/place.

vplace

canvas_demo

Features

  • Real Time Per Pixel Update Info
  • 16 color support
  • cooldown validation
  • ablity to update cooldown and canvas dimension.
  • admin can bypass cooldown and reset canvas
  • REST Api build using actix-web
  • realtime canvas update based on websockets.
  • Redis bitfild for storing canvas data (4bits/pixel).
  • Pixel Updates are stored on Scylladb

Installation

To install and run the v-place api, follow the steps below:

  1. Clone the repository:

    git clone https://github.com/v4zha/v-place
    
  2. Navigate to the project directory:

    cd v-place
    
  3. rename the sample.env to .env file in the project root directory and set the required environment variables. For example:

    HOST=0.0.0.0
    PORT=8080
    REDIS_URL= "redis://redis:6379"
    SCYLLA_URL="scylla:9042"
    CANVAS_DIM=500 #Square canvas (dim * dim)
    CANVAS_ID=vplace_1
    COOLDOWN=30 #cooldown in seconds
    ADMIN_TOKEN="enter secret admin token"
  4. run docker contrainer using docker compose

    docker compose up
    

Todos

  • v-place UI
  • user Auth and Validation
  • log all updates

About

v-place a digital canvas where artist collaborate to create art heavily inspired by r/place

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published