Skip to content
This repository has been archived by the owner on Sep 21, 2021. It is now read-only.

Options & Documentation #1

Open
demipixel opened this issue Jan 6, 2018 · 3 comments
Open

Options & Documentation #1

demipixel opened this issue Jan 6, 2018 · 3 comments

Comments

@demipixel
Copy link

Assuming this project isn't dead (4 days of commits and then dead silence, I know what that pattern means ;P), usability is key for other people to use it!

  • Add options such as
    • Choice to render lines/numbers or not
    • Background color (or no background if something will already be rendered on the canvas)
    • Camera options to allow zooming/scaling of the render as well as panning (in case devs wish to capture only a certain part of a Blueprint or make a dynamic tool for users to explore and perhaps modify blueprints)
  • Documentation (nothing fancy, just enough so devs know what to do)
  • Fix up the package.json (really you should npm init and then readd the dependency and script, but at a minimum you'd need a version number and main file)
  • Publish to npm! Woot!
@Vilsol
Copy link
Member

Vilsol commented Jan 6, 2018

Wow, you actually reminded me of this at the right time, I will be adding loads of configuration options soon, as well as make a full rewrite to typescript.

@albertel
Copy link

albertel commented Apr 2, 2018

I was trying to make use of this and it's unclear what the data.json file is expected to look like. Adding a doc on how to generate that or which library to use would be really helpful.

@Enoumy
Copy link

Enoumy commented Mar 16, 2020

I was trying to make use of this and it's unclear what the data.json file is expected to look like. Adding a doc on how to generate that or which library to use would be really helpful.

I was wondering this too!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants