teachanddraw
A canvas based drawing library and 2d game engine designed purely for teaching an introductory level set of content. Focus is on a smaller command set so students will be able to get familiar with the library quicker.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.8%) to scientific vocabulary
Repository
A canvas based drawing library and 2d game engine designed purely for teaching an introductory level set of content. Focus is on a smaller command set so students will be able to get familiar with the library quicker.
Basic Info
Statistics
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 26
- Releases: 0
Metadata Files
README.md
TeachAndDraw
Please Note TeachAndDraw is under active development. This JavaScript library has been developed as a teaching and learning tool and is deliberately simple, to minimise the mental overhead while learning programming. The aim of this library is to provide a set of easy to use functions to draw shapes and images onto a HTML5 Canvas, while providing support for loading resources, handling various native events and providing simple 2D physics.
The original concept was inspired by the P5js and P5Play libraries, but with a more controlled and consistent feature set. We felt that the P5 libraries have suffered from scope creep over time, which has led to them straying from the original design, and introducing inconsistencies as developers changed. The design choices within this library have a focus on making it easy for new programmers to understand, allowing simple code to produce interesting and complex applications.
Despite providing error checking and additional layers of abstraction, being lightweight and performant is still important for us, as we need to cater for low-end hardware that students often have access to.
Core Principles
Consistency supports learning
Consistent patterns of behaviour help learners build a more accurate mental model, and their confidence as coders.
The most significant impact this has on the design of TeachAndDraw is that the library has a limited instruction set. This allows learners to become familiar with all of their options and build a good understanding of the tools available for solving problems.
Other elements of TeachAndDraw that support consistency include:
- If a function takes x, y coordinates as parameters, they will be the first 2 parameters.
- All shapes are drawn from their centre point.
- All visual entities (images, animations, colliders) use the same properties.
- The in-built maths library uses degrees for all angle mathematics; and 0 degrees is at the top of a shape. This is to take advantage of recent high school grads’ prior mathematics experience.
Errors need to occur close to the source of the issue
We use runtime type checking and detailed error messages throughout the library to give learners quick feedback close to where errors occur. This means they can both address the error and learn from it.
Performance matters
Students are famously poor. Many learners will be working on low-power, low-RAM and/or older computers. TeachAndDraw has been optimised for performance to support users on a wider range of hardware.
Code doesn’t have to rot
TeachAndDraw has no dependencies and is written in raw JavaScript to facilitate this.
Getting Started
TeachAndDraw is still under development and isn’t ready to be used yet.
While a good chunk of the library is functional and able to be used, there are many known bugs that are listed to be fixed, and some core features missing. This means that while it is under development, there may be structural and namespace changes that would break applications built on the current version.
Documentation
Please refer to our current student facing API.
Owner
- Login: JamesBakerMM
- Kind: user
- Repositories: 1
- Profile: https://github.com/JamesBakerMM
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: TeachAndDraw
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: James
family-names: Baker
- given-names: Andrew
family-names: Paroz
affiliation: CSIRO
orcid: 'https://orcid.org/0009-0008-0626-007X'
- given-names: Britney
family-names: Gwynne
- given-names: Jessica
family-names: Korte
orcid: 'https://orcid.org/0000-0002-4412-7199'
- given-names: Nicholas
family-names: Bland
- given-names: Michael
family-names: Ellicott
abstract: >-
TeachAndDraw.js is a JavaScript library that has been
developed as a teaching and learning tool and is
deliberately simple, to minimise the mental overhead while
learning programming. The aim of this library is to
provide a set of easy to use functions to draw shapes and
images onto a HTML5 Canvas, while providing support for
loading resources, handling various native events and
providing simple 2D physics.
license: MIT
GitHub Events
Total
- Issues event: 70
- Delete event: 41
- Member event: 2
- Issue comment event: 15
- Push event: 240
- Pull request review comment event: 19
- Pull request review event: 59
- Pull request event: 88
- Fork event: 1
- Create event: 45
Last Year
- Issues event: 70
- Delete event: 41
- Member event: 2
- Issue comment event: 15
- Push event: 240
- Pull request review comment event: 19
- Pull request review event: 59
- Pull request event: 88
- Fork event: 1
- Create event: 45
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 19
- Total pull requests: 16
- Average time to close issues: about 2 months
- Average time to close pull requests: 5 days
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 0.37
- Average comments per pull request: 0.0
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 18
- Pull requests: 16
- Average time to close issues: about 1 month
- Average time to close pull requests: 5 days
- Issue authors: 1
- Pull request authors: 3
- Average comments per issue: 0.33
- Average comments per pull request: 0.0
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- JamesBakerMM (65)
- NickBland (2)
- andrewparoz (2)
- jkorte (2)
- AshleyPer (2)
- bridget512 (2)
- brit12345 (1)
- Psychicbear (1)
- mellic03 (1)
Pull Request Authors
- mellic03 (35)
- andrewparoz (25)
- brit12345 (7)
- JamesBakerMM (7)
- jkorte (5)
- NickBland (4)
- AshleyPer (2)