Skip to content

Commit

Permalink
Cleaned up the project and fixed a few issues I found.
Browse files Browse the repository at this point in the history
  • Loading branch information
zedseven committed Jan 22, 2022
1 parent bb5c093 commit 3f36eaa
Show file tree
Hide file tree
Showing 12 changed files with 303 additions and 200 deletions.
9 changes: 4 additions & 5 deletions .gitattributes
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
95 changes: 90 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,92 @@
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# General Files
tmp/

# JetBrains gitignore (https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore)

# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# AWS User-specific
.idea/**/aws.xml

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# Directory-based project format
*.iml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# SonarLint plugin
.idea/sonarlint/

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

# Completely ignore the .idea directory
**/.idea/


# Eclipse gitignore (https://github.com/github/gitignore/blob/master/Global/Eclipse.gitignore)
Expand Down Expand Up @@ -85,8 +169,9 @@ local.properties
.scala_dependencies
.worksheet


distribution/*
data/
distribution/
lib/
.project
.classpath
core.jar
core.jar
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 Zacchary Dempsey-Plante
Copyright (c) 2022 Zacchary Dempsey-Plante

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
45 changes: 31 additions & 14 deletions README.md
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.
10 changes: 5 additions & 5 deletions resources/build.properties
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ library.categories=Animation,Other
# like mentioning that it's a Library. This should start with a capitalized
# letter, and end with a period.

library.sentence=A gaming library that enables easy 2D game creation within Processing.
library.sentence=Easy, simple 2D game creation within Processing.


# Additional information suitable for the Processing website. The value of
Expand All @@ -132,12 +132,12 @@ source.repository=https://github.com/zedseven/Green.git
# This is used to compare different versions of the same Library, and check if
# an update is available.

library.version=5
library.version=6


# The version as the user will see it.

library.prettyVersion=1.0.5
library.prettyVersion=1.1.0


# The min and max revision of Processing compatible with your Library.
Expand All @@ -148,7 +148,7 @@ library.prettyVersion=1.0.5
# break in a later (or earlier) release. Otherwise, use the default value 0.

compatible.minRevision=0
compatible.maxRevision=0
compatible.maxRevision=0270


# The platforms and Processing version that the Library has been tested
Expand All @@ -160,7 +160,7 @@ tested.processingVersion=3.5.4

# Additional information for the generated webpage.

library.copyright=© 2018-2021 Zacchary Dempsey-Plante
library.copyright=© 2018-2022 Zacchary Dempsey-Plante
library.dependencies=?
library.keywords=processing,greenfoot,games,game-development,learning,education

Expand Down
Loading

0 comments on commit 3f36eaa

Please sign in to comment.