🏠 3D Simulator for interior design
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public
src
test
.bowerrc
.editorconfig
.gitignore
.jscsrc
.jshintrc
.travis.yml
LICENSE.md
README.md
bower.json
gulpfile.js
karma.conf.js
package.json

README.md

Decoraki Logo

3D Simulator for interior design - http://www.decoraki.co

Decoraki

Build Status

Decoraki is a 3D simulator that aims to help people to decorate and furnish their homes, providing them a way to inspire, combine products and bring their ideias to life.

Install

First install all dependecies

npm install

And then run the project

npm run dev

File format

Decoraki only supports 3D collada(.dae) format. If you have another 3D file format, don't worry, it's very easy to convert. You can use softwares like SketchUp, Blender and Collada Exporter for Unity3D.

How it works

First we need to create a model(you can see all examples in src/helpers/decoraki.repository.js):

    var sofa = {
        model: 'Sofa01.dae',
        lightMap: 'Sofa01_LM.jpg',
        folderName: 'Sofa01',
        descriptionName: 'Kael The Invoker',
        descriptionImage: 'invoker.jpg',
        moveType: 'floor',
        category: 'furniture'
    };

Two properties are important: category and moveType.

The category property can be a room, furniture or texture, it defines the model's behavior. For example: If the model's category is a furniture you can drag, rotate and delete.

The moveType property defines if an object can be dragged in wall, floor or both.

To insert the sofa in simulator:

    simulator.insertObject(sofa);

Browser Support

Unfortunately WebGL isn't fully supported by all browser, but as you can see here Chrome(45+) is the best browser to run this project.

Contributing

If you want to colaborate check the project's issues.

  1. Fork the repository
  2. Create a new branch
  3. Implement your solution
  4. Commit
  5. Open a Pull Request

Remeber: Always run lint and test. If you change the core system update the tests.

Thanks!

License

MIT License © Vitor Abner