-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleaned up the project and fixed a few issues I found.
- Loading branch information
Showing
12 changed files
with
303 additions
and
200 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
data/* linguist-vendored | ||
distribution/reference/* linguist-documentation | ||
distribution/* linguist-vendored | ||
lib/* linguist-vendored | ||
resources/* linguist-vendored | ||
web/* linguist-vendored | ||
distribution/* linguist-generated | ||
resources/* linguist-vendored | ||
web/* linguist-vendored | ||
*.pde linguist-detectable=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,40 @@ | ||
# Green | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
# [Green](https://zedseven.github.io/Green/) | ||
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) | ||
[![# Issues](https://img.shields.io/github/issues/zedseven/Green.svg?logo=github)](https://github.com/zedseven/Green/issues) | ||
|
||
#### A library for Processing written by Zacchary Dempsey-Plante | ||
This is a relatively simple library designed to emulate most of the features of [Greenfoot](https://www.greenfoot.org/) in [Processing](https://processing.org/). | ||
This was done for a school project and aims to enable easy 2D game creation within Processing. | ||
This is a relatively simple library designed to emulate most of the features of [Greenfoot](https://www.greenfoot.org/) | ||
in [Processing](https://processing.org/). | ||
This was originally made for a school project and aims to enable easy 2D game creation within Processing. | ||
|
||
If you're using this in a class or as a teaching tool, I'd love to hear about it! | ||
|
||
## Installation | ||
First, go to the Releases tab and download the .zip file, and unzip it to wherever you want to keep the library. | ||
To install the library, simply open `Green-<version>.zip\library\` and put `Green.jar` in your Processing libraries folder. | ||
Processing's `libraries` folder is located in `<sketchbookLocation>\libraries`, and it's sketchbook location can be found in the editor under `File > Preferences...`. | ||
1. `Sketch > Import Library... > Add Library...` | ||
2. Search for `Green` | ||
3. Select the library and click `Install` | ||
|
||
### Manual Installation | ||
These steps are only in case the above steps don't work. You should try them first. | ||
|
||
1. Go to the [latest GitHub release](https://github.com/zedseven/Green/releases/latest) | ||
2. Download the `.zip` file | ||
3. Unzip it to wherever you want to keep the library | ||
4. Open `Green-<version>.zip/library/` and put `Green.jar` in your Processing libraries folder | ||
5. Processing's `libraries` folder is located in `<sketchbookLocation>/libraries` | ||
- Its sketchbook location can be found in the editor under `File > Preferences...` | ||
|
||
From there, select `Sketch > Import Library...` in the editor, and Green should show up for selection. | ||
Once installed: | ||
1. Add it to a project with `Sketch > Import Library...` | ||
2. Select it from the popup list | ||
|
||
## Reference | ||
To see the Javadoc reference, please visit [https://zedseven.github.io/Green/](https://zedseven.github.io/Green/). | ||
To see the Javadoc reference, please visit https://zedseven.github.io/Green/. | ||
|
||
## A brief run-down | ||
The library works with two basic classes: `Worlds` and `Actors`. | ||
## The Basic Idea | ||
The library works with two concepts: worlds and actors. | ||
|
||
The `World` class is where all the interaction and gameplay takes place - it's where all the `Actors` live, and for most games one `World` is enough. | ||
The `World` class is where all the interaction and gameplay takes place - it's where all the `Actors` live, and for most | ||
games one `World` is enough. | ||
|
||
The `Actor` class is where all the per-item code goes: you might have a player `Actor`, one for an item the player can pick up, and maybe a few ones for obstacles. | ||
The `Actor` class is where all the per-item code goes: you might have a player `Actor`, one for an item the player can | ||
pick up, and maybe a few for obstacles. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.