mcluck90 / clairvoyant

A simple language which creates Psykick game skeletons

Hello!

Check out my website where I sometimes make/write things.

• 🔭 I’m currently working on a programming language (it's in a weird spot right now 🚧)
• 💬 Ask me about web development and compilers

clairvoyant's Issues

Users can't disable console output

Users should have the ability to disable console output and not see any kind of build report.

Required Components not added to Factory

Each entity type requires a set of Components to be properly constructed. Those Components aren't currently being added to the list of required modules up top.

Allow JSON Output

Allow the user to output the results in a useful JSON format. Possible format would be:

{
    "name":         "Name of the Game",
    "warnings":   [ "Array of warning messages" ],
    "error":        "null or fatal error message",
    "components": [ "Array of component filenames" ],
    "systems":    [ "Array of system filenames" ]
}

Add "preprocessors" for predefined elements and modules

Psykick has some built in Components and Systems. Users should be allowed to reference these from within their ct files. Furthermore, users should be able to break their projects into multiple files.

Should have an option to only generate new files, not overwrite old ones

The compiler only provides a skeleton and the user has to implement functionality. It would be a shame to define a complex system then accidentally overwrite it when re-compiling a project for some new components.

Alternatively, perhaps it should only generate new ones by default and you have to force it to overwrite files.

Inherited systems are not given render/update skeletons

When compiling for Psykick2D, RenderSystems and BehaviorSystems should have draw and update functions, respectively. Each of these will usually operate on each of their entities. The compiler should generate basic functions which do this.

NAME not being set on Components

Components require a property, NAME, to differentiate them from other Components. This name is not being assigned during compilation.

World is not properly exposed in Factory

Expected:

var World = require('psykick{2d|3d}').World;

Actual:

var World = require('psykick{2d|3d}');

Not all functions properly documented

Every function should have good documentation about what it's for.

Automatic documentation generation not working on nested objects

Each Component has some automatic Closure Compiler style documentation attached to the top. If we have any nested objects in the options parameter, they should receive their own entries in the documentation.

Example:

/**
 * @param {Object} option
 * @param {Object} [option.a]
 * @param {Object} [option.a.b]
 * @constructor
 */
var SomeComponent = function() { ...