Skip to content

Database Format

keith edited this page Nov 22, 2019 · 4 revisions

Courses (Work in progress)

{
    id: <Object ID>,
    name: "Title",
    description: "describe something here",
    difficulty: <int of how hard it is>,
    shortname: "used for url",
    lessons: [
        {
            name: "Lesson name",
            prompt: "prompt under name",
            code: "code to go in editor",
            categories: [Array of strings describing categories]
        },
        ...
    ]
}

Scenes (WIP)

{
    id: <unique id for the scene>,
    name: <name of the scene>,
    uid: <id of the owner of the scene>,
    desc: <description of the scene>,
    code: <code for the scene>,
    settings: {
        map: {
           skyColor: <string of hex color code>,
           showFloor: <boolean>,
           floorColor: <string of hex color code>,
           showCoordHelper: <boolean on whether to show grid or not>
        },
        camera: {
           positon: <a string "x y z" (since expected in A-Frame)>,
           config: <0 is normal camera movement, 1 is movement to checkpoints>,
           canFly: <boolean on whether the camera can move up/down>,
       },
       viewOnly: <boolean determining editability>,
       collection_id: <id of collection that the scene belongs to>
    },
    createTime: <date/time scene was intially created>,
    updateTime: <date/time of last update to the scene>
}