Giter VIP home page Giter VIP logo

hammurabi's Introduction

hammurabi

The reference/educational implementation of the Decentraland protocol.

This implementation uses the babylon.js framework and runs entirely on web browsers.

This project's goals are to:

  • document current and future protocol standards
  • experiment with changes to the protocol
  • guide new contributors into how Decentraland works
  • enable easy prototyping of new features

This repository is the companion material for the implementation guide (still work in progress, check out this design doc and ongoing documentation of the protocol).

Status: Proof of Concept, does not run

Commit Guide

  • This commit sets up the tooling to build the project. It uses Typescript as language, esbuild to compile and build the project, npm for package management, jest for tests, and GitHub actions for continuous integrattion.

Building and Running

  1. Clone the repo using git clone https://github.com/decentraland/hammurabi
  2. cd hammurabi to move into the repo
  3. make watch to start the development web server
  4. Open https://localhost:7081

Additionally, make build builds the project into the ./static folder, and make test executes all tests.

Testing

  • make test executes all the tests
  • make test-watch executes all the tests and watches for file changes to run the tests again
  • make test-watch TESTARGS='test/file.spec.ts' runs the tests of test/file.spec.ts

Testing realm

This repository includes a "testing realm". It is a set of scenes compiled and served statically as a regular realm. The file structure is generated by running the sdk-commands export-static command of the Decentraland SDK.

Since it uses the SDK out of the box, it is also possible to run the scenes in the embedded official Decentraland Explorer for compliance testing. You can do that by running make sdk-watch, it will first build the scenes and then launch a web server to use the explorer. It is important to notice that the babylon exlorer does not work with the "sdk-watch" mode yet, it only works with static the files generated by make build-testing-realm

hammurabi's People

Contributors

menduz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

morph-bot

hammurabi's Issues

Pending scene tests

  • Billboards
  • Nested billboards
  • Billboard with transformed camera position (scene-local vs global position)

Document static entities

  • Each one of them
  • Which components can we expect in these entities
  • Who can change components on the static entities (renderer? scene?)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.