Skip to content

Commit

Permalink
(#20) update example readme with added examples
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasstarsz committed Jun 27, 2021
1 parent a214f1f commit 93ecc32
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion src/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,52 @@ Then, run the gradle task `example`. When you do this, you'll need to specify wh
```
_Having trouble using `gradlew`? Read [this][Terminals Are Different]._

## Example Programs

# Example Programs

## Informational
_These are examples to help you understand how FastJ works._

### Hello, FastJ!
This program is a remarkably simple introduction to starting work with FastJ. It initializes the engine and runs the engine, which results in an empty window. This also can serve as a project template for working with FastJ.

Command to run: `./gradlew example -PtoRun=hellofastj`

### Logging
This is designed to show you how logging works in FastJ.

Command to run: `./gradlew example -PtoRun=logging`

### Engine Configuration
This program demonstrates the different available configurations for FastJ: Window/Game Resolution, FPS/UPS configuration, and hardware acceleration.

Command to run: `./gradlew example -PtoRun=engineconfig`

### Keyboard
This program demonstrates how to access keyboard input in FastJ.

Command to run: `./gradlew example -PtoRun=keyboard`

### Polygons
This program demonstrates how to create and draw polygons using the `Polygon2D` class.

Command to run: `./gradlew example -PtoRun=polygon2d`

### Text
This program demonstrates how to create and draw text using the `Text2D` class.

Command to run: `./gradlew example -PtoRun=text2d`

### Models
This program demonstrates how to create and draw 2D models using the `Model2D` class.

Command to run: `./gradlew example -PtoRun=model2d`

### Reading and Writing Models to Files
This program demonstrates how to read and write polygons from and to a file.

Command to run: `./gradlew example -PtoRun=modelreadwrite`

### (Old) Hello, World!
This project is an introduction to working with FastJ, and covers many of the essential topics:
- Engine Initialization/Running
Expand All @@ -29,6 +68,10 @@ This project is an introduction to working with FastJ, and covers many of the es

Command to run: `./gradlew example -PtoRun=oldhelloworld`


## Games
_Example programs to demonstrate FastJ through games._

### Bullet Hell
This project takes the concepts we've learned so far and meshes them together into a game!

Expand Down

0 comments on commit 93ecc32

Please sign in to comment.