Start to cleanup and restructure

[coreyar]

Creating a pull request to get thoughts on the restructuring and cleanup.

• Regarding duplicated files like the engines and responsive templates, I removed duplicates in favor of the more complete version.
• There were some great resources about inheritance, the publish-subscribe pattern and namespaces. I moved those to a "concepts" dir and converted them to markdown. I saw those files as growing into part of the project documentation.
• Removed React and shine because I couldn't see where they were used. I do think React would be a good framework candidate for the UI.

I am not as familiar with the namespace pattern this project uses. I am more familiar with using modules to control scope and using webpack to bundle the code but I can understand how the namespace function is working. I will probably dive more into how the game engine works and see how it fits in with the code in src

[besnik]

Hi Corey, thanks for update. I have following suggestions and then question where I need more clarifications.

few questions I have:

• concepts directory is okay, but we should to separate each concept into dedicated sub-directory and put back .js files. There could be more implementations of same concept and perhaps you want to try if something is working or not directly in browser. That's why it is important to have .js and/or .html file where you can test things quickly. I would suggest to keep code in .html/.js files and readme.md should explain concept in general and high level. We could document some details there but I would not duplicate code into 'readme' files.
• I would refactor src/ directory a bit - I would prefer to have there actual and most up-to-date version of engine + UI implementations. This way everybody could easily find what's the latest version of the code. Old models/PoC should be kept in an archive folder or removed once it is clear we don't need them.
  • I would suggest that src/ contains current impl of engine and responsive web UI
  • it is important to separate engine from UI - I would keep these two separated in sub-directories to make clear distinction between them. Also this way other developers could better understand what belongs to core and what is just UI wrapper (web, mobile, desktop) around core (engine).
  • it could be like src/engine/ for core model of engine and editor and then src/web/ for responsive web UI that could contain .html files, perhaps react impl, etc; There could be more implementations of UI (in theory if there is time) like src/web, src/web_angular,src/desktop`. Not 100% sure how it would end up but we should definitely separate engine from UI.
  • in src/engine/ I would movepoc/engine/`
  • if you have experience with react or react native and want to build prototype you could do so it src/web or src/mobile or something like that
• what is the purpose of package.json? Why is it needed? (probably you need to educate me here how it helps us and how to use it - I would welcome some links or improved main readme.md on usage)
• the same goes for webpack as I don't have exp with it.

[coreyar]

• Concepts Directory Sounds good. I have prepared those changes and can push them up.
• /src I agree that this should be the home for the most recent version of the code. I haven't dug into the code that's in there yet but I have begun checking out the code in /poc. Ideally I would like to be able to install the the files from npm or yarn and organizing them in src is a good way to prepare for that. I have also give it some thought that it might make sense to seperate this project into a couple repos. 1) The game engine and maybe the editor 2) any supporting UI elements. That way users can use the game engine with their own UI elements and not have to download the available UI elements. It will also allow users to easily extend one or the other.

Are you suggesting to replace /src with the engine code in /poc? I think /poc could be renamed to /example so that a user could install the project and have a working example. I have experience in react and react-native and have a very basic prototype build in react in the /poc folder.

• The package.json contains all information about building and running a project including any dependencies. In the same directory of the project you can run npm install or yarn install to install dependencies. It can also contain scripts for building and linting the project.

• Webpack is a javascript and assets bundler. With it you can use babel plugins to transpile es6, jsx, and other javascript dialects.

I'll update the README.md with information about running the example.

[coreyar]

I pushed up a much more robust reorganization.