Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 2.28 KB

README.md

File metadata and controls

71 lines (57 loc) · 2.28 KB
Raw

PixeLAW Core(MUD Based)

PixeLAW is a pixel-based Autonomous World.

This repository includes core components and systems, which inspired by PixeLAW Core(Dojo Based), and built on top of MUD for EVM compatible. For more details, please check PixeLAW Book.

Concepts

  • World : A Cartesian plane (2d grid), where every position represents a "Pixel"
  • Pixel : One x/y Position, that has 6 primitive properties and one behavior template (App)
  • App : A Pixel can have only one App that defines its behavior
  • App2App : Interactions between Apps, where allowed
  • Action : A specific behavior in the context of an App
  • Queued Action : Action to be executed in the future, can be scheduled during an Action

App Core Behavior (for owner)

  • register : Register the App in the World
  • unregister : Remove the App from the World
  • allow_app
  • disallow_app

App Properties

  • name
  • permissions (bool hashmap of appname+property)

Core Pixel Behavior

  • update_all
  • update_app
  • update_color
  • update_owner
  • update_text
  • update_alert
  • update_timestamp

Pixel Properties (every Pixel has these)

  • position (cannot be changed)
  • app
  • color
  • owner
  • text
  • alert
  • timestamp

Default App

  • paint(put_color, remove_color)
  • snake(spawn, move)

Prerequisites

Quickstart(Deploy Locally)

Step 1: Clone repo

git clone https://github.com/themetacat/pixelaw_core.git

Step 2: Install packages

cd pixelaw_core && pnpm install

Step 3: Deploy and Start

pnpm run start

Step 4: Stop

!!! Warning: Please be aware that this command will terminate all processes containing the keywords 'anvil' and 'vite'. Please use it with caution.

pnpm run stop

License

PixeLAW Core(MUD Based) is open-source software under the MIT license.