Skip to content

Instantly share code, notes, and snippets.

@psvensson

psvensson/ViralityEngine_ideas.md

Last active November 23, 2022 13:24
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save psvensson/3acd5ea7f5bf059d4cdac334b05f13a4 to your computer and use it in GitHub Desktop.
Save psvensson/3acd5ea7f5bf059d4cdac334b05f13a4 to your computer and use it in GitHub Desktop.
Download ZIP
Some thought on how to improve the epxerience for newcomers to Virality Engine
Raw
ViralityEngine_ideas.md

Notes from a newbie getting started on Virality Engine.

Github page(s)

https://github.com/bufferswap/ViralityEngine

Very good README. Overview, Install and Usage understandable and works to get a newcomer up and running (I use Linux).

Nice to haves

  • A bit longer overview of how the DSL works and looks like, showing a short example and maybe a screenshot.

  • A separate documentation page, linked from the overview above, where each part of the DSL is explained briefly, with a code example.

Code organization

Hard to comment on in detail, since I do not know Lisp that well yet, but one thing does stand out, and that is the organization of the code partly in relation to loading sequence. This makes it harder to find what you’re looking for (core-early and core-late, for example). it would be nice to have it organized per idea, so that maybe you could find all things gltf in the same directory. Perhaps this is not a good idea, and it all depends on what categories of ideas you want to sort on, of course.

Examples

There are a lot of examples, which is really nice. It might be at some point soon that you would need to organize the examples into at least one layer of categories, to make sure they fit on screen.

Regarding the naming and content of the examples, there is not an easy way to understand which example (shown in the running list/chooser of examples) can be found in which file. It would be easier if naming could be harmonized in some way, maybe also some examples split out into separate files.

Also, inside each example file, it would be a great help if each could be heavily commented on, explaining how things work, what alternatives might be, how things are related, et.c.

Possible improvements

It would be nice to have a couple of small tutorials around existing of new examples. A tutorial could be a separate md file which lays out the text a bit more on the practicalities of doing something simple, to make it easier to get started.

One such tutroail (that I'd really like to have) could contain

  • Creating the simplest possible basic building blocks like camera, et.c.
  • Creating a patterened floor (explaining the simplest possible use of textures and materials)
  • Creating a basic shape, like a cube, again with a texture as above, but different.
  • Binding controls to move the shape in two dimensions (but viewed in 3d, maybe isometric)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment