Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevekrouse/WoofJS
Learnable JavaScript
https://github.com/stevekrouse/WoofJS
animation education games learn student woof
Last synced: 3 days ago
JSON representation
Learnable JavaScript
- Host: GitHub
- URL: https://github.com/stevekrouse/WoofJS
- Owner: stevekrouse
- License: mit
- Created: 2016-05-02T00:30:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-23T18:42:18.000Z (about 1 year ago)
- Last Synced: 2024-06-17T11:34:54.083Z (5 months ago)
- Topics: animation, education, games, learn, student, woof
- Language: HTML
- Homepage: http://woofjs.com
- Size: 84.8 MB
- Stars: 146
- Watchers: 10
- Forks: 45
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# WoofJS [](https://github.com/stevekrouse/WoofJS/blob/master/LICENSE.md) [](https://www.codetriage.com/stevekrouse/woofjs) [](https://c9.io/auth/github?r=https%3A%2F%2Fc9.io%2Fopen%2F%3Fclone_url%3Dhttps%253A%252F%252Fgithub.com%252Fstevekrouse%252FWoofJS)
WoofJS is a *learnable* JavaScript framework for creating games by [The Coding Space](http://thecodingspace.com).
WoofJS was created to be the next step after block-based coding in Scratch. For more details, you can [read our announcement post](https://medium.com/@stevekrouse/woof-d9adf2110fc6).
## Getting Started (woofjs.com)
We recommend that you get started with WoofJS on [woofjs.com](https://woofjs.com), because you...
* can get started with zero set-up
* use our [interactive and searchable documentation](https://woofjs.com/docs)
* get access to [our WoofJS curriculum](https://coding.space/woof)
* create an account to save your work
* use our text-editor fine-tuned for use with WoofJS, including code-hints and type-a-head
* iterate quickly with live updates to your output as you type
## Getting Started (outside woofjs.com)
### Installing WoofJS
#### For development (which always grabs the latest version):
```html
```
#### For production (which is tied to a specific commit hash):
Go to [raw.githack.com](https://raw.githack.com/) and type this in:
https://github.com/stevekrouse/WoofJS/blob/master/woof.js
And grab the link on the left, which should look like:
```html
```
### Global mode
When you include the Woof script in your code, it defaults to creating a full-screen project and polluting your global namespace with Woof's methods.
We find not having to type "Woof." over and over again makes a huge difference for beginner programmers, especially those new to typing.
However, if you'd like to turn off this mode, simply add `global="false"` in your HTML script tag:
```html
```
Then in your JavaScript, you'd need to create your project manually:
```javascript
var project = new Woof({global: false, width: 300, height: 400})
var IMAGE_NAME = new project.Image({project: project, url: "https://woofjs.com/images/SMJjVCL.png"})
```
### Full Screen
You can disable the fullScreen default by putting `fullScreen=false` in your JavaScript code and then manually setting the size you'd like it to be:
```javascript
fullScreen = false
setBackdropSize(500, 300)
```
**Note**: `setBackdropSize(x,y)` only accepts number inputs. If you'd like your background to be a percentage of the screen size, you need to calculate that yourself:
```javascript
// set the x to 50% of the window's width and y to 500px
setBackdropSize(window.innerWidth * (50/100), 500)
// every time the window resizes, recalculate the width from the `window.innerWidth` property
window.addEventListener("resize", () => {
setBackdropSize(window.innerWidth * (50/100), 500)
})
```
## Reporting a bug
Simply create an issue with a link to the simplest code you can create that would reproduce the bug, preferably on [woofjs.com](https://woofjs.com).
## Contributing
WoofJS is used by hundreds of students from all over the world to build games and animations.
We'd love your help in making it even more learnable and dependable for them.
### The WoofJS directory structure
#### woofjs.com
[woofjs.com](https://woofjs.com) is hosted on Github pages from this repository. This means that all of the top-level URLs on [woofjs.com](https://woofjs.com) must be in the top-level of the directory. This includes:
* index.html
* create.html
* full.html
* teach.html
* user.html
* login.html
* favicon.png
* etc
The documentation that you find on [woofjs.com/create.html](https://woofjs.com/create.html) is contained within the [docs](https://github.com/stevekrouse/WoofJS/tree/master/docs) folder.
#### WoofJS.com's Tutorials
[WoofJS.com](https://woofjs.com)'s tutorials actually live at an entirely different repo: https://github.com/stevekrouse/coding.space.
You can find them there in the `woof/` subdirectory. If you'd like to contribute to the WoofJS curriculum, head on over to that repo.
### Getting started
1. We recommend using https://c9.io as your development environment -- when you create an account, it asks for a credit card, but it won't charge you.
2. Create a new basic HTML workstation, and clone the Woof repository.
```
git clone https://github.com/stevekrouse/WoofJS.git
```
3. Set your git username: https://help.github.com/articles/setting-your-username-in-git/
4. Install the npm dependencies.
```
npm install
```
5. Take a look at our issues and see if there are any issues that speak to you as good places to tackle first. Pay particular attention to issues labeled "good for beginners."
6. Make sure that you are branching from a clean master.
```
git checkout master
```
and
```
git pull
```
7. Create a new local branch to work on your issue -- use a descriptive branch name like in this example:
```
git checkout -b more-pokemon-sprites
```
8. Stage your changes to be committed.
```
git add .
```
9. Once you've made and staged your changes, commit them to your branch.
```
git commit -m "add more pokemon sprites"
```
10. Push your new branch (not master!) to the GitHub repo.
```
git push origin more-pokemon-sprites
```
11. Submit a pull request so your changes can be reviewed.
If you have any questions, please email steve at futureofcoding.org :)
## License
MIT License, so do with our code as you will. If you want help using the code or integrating with WoofJS, we're happy to help :)