kevinshen56714 / SkyOffice

Immersive virtual office built with Phaser, React, Redux, PeerJS, and Colyseus.
https://sky-office.co/
MIT License
930 stars 289 forks source link

Is there documentation somewhere #28

Open pinpox opened 2 years ago

pinpox commented 2 years ago

I'd like to use this project but the documentation seems to be missing. The readme gives a bit of help, but not much.

This project looks great and I would love to use it, but the lack of documentation is making it quite hard.

kevinshen56714 commented 2 years ago

Hi @pinpox, thank you and sorry for the late reply. We have quite some plans for this project, and we're actively working on it! For example, very recently, we added whiteboards (#18) and custom room functionality (#29), which hopefully can address some of your comments.

Regarding the documentation, I think it's still early for us to focus on that because our codebase can be rapidly changing at this stage. However, we will be posting latest updates here on GitHub as well as on our new Twitter!

pinpox commented 2 years ago

Thank you! I'll keep an eye on the project, looks promising. Adding docs would make it easier to contribute though.

basilbowman commented 1 year ago

@kevinshen56714 if you're available to chat with me, I'd gladly volunteer to write some docs (in exchange for not having to reverse engineer ALL of the map data format, for example )

kevinshen56714 commented 1 year ago

@basilbowman sorry for my late reply. We are now working on migrating SkyOffice's site hosting from Heroku to Render. I will take some time to write some dev docs as well. Stay tuned!

basilbowman commented 1 year ago

Sure dude - mostly I meant I'd write up some Level 2 User docs - like, "here's how to get it running, here's how map formats work, stuff like that." I'm documenting as much as I can here: https://medium.com/@nathan.g.bowman/my-attempt-at-building-in-public-pt-1-2a7088325e6 - but I'd LOVE to chat with you for an hour or so instead :)

namnm commented 1 year ago

Thank you for open source this great project. Someone forked this repo into a product and put their webrtc service on sale https://gather.town/

basilbowman commented 1 year ago

Thank you for open source this great project. Someone forked this repo into a product and put their webrtc service on sale https://gather.town/

Lol - I was one of the first employees at Gather - SkyOffice is an OSS clone of Gather, not the other way around :)

namnm commented 1 year ago

Oops thanks for your info. I wonder there would be chance that if we use this open source repo then might get caught in a legal issue with Gather since these 2 are too similar, not mentioning source code but at least on the idea and appearance.