Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example Programs #20

Open
16 of 18 tasks
lucasstarsz opened this issue May 23, 2021 · 2 comments
Open
16 of 18 tasks

Example Programs #20

lucasstarsz opened this issue May 23, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@lucasstarsz
Copy link
Member

lucasstarsz commented May 23, 2021

Is your feature request related to a problem? Please describe.

The lack of tutorials for how to use FastJ greatly hinder a newcomer's ability to effectively use the game engine.

What should the solution be like?

Add tutorials to FastJ depicting how just about anything in FastJ works -- from an empty window, to rendering game objects, to adding game object behaviors, to scene management, etc.

Anyone is free to create tutorials!

@lucasstarsz will be proofreading and content-checking tutorials as needed.
You may also request that I notify you if your tutorial needs to be updated for whatever reason -- you can opt out of this at any time.

Tutorials to complete

  • Using SimpleManager
    • Empty Window -- Hello, FastJ!
  • Using Drawables
    • Creating/Rendering a Game Object
    • Creating/Rendering a UI Element
    • Creating Models
    • Writing/Reading Models to .psdf format
  • Using FastJEngine
    • Using FastJEngine#log/warning/error
    • Using FastJEngine#configure
    • Using FastJEngine#setTargetFPS
    • Using FastJEngine#setTargetUPS
  • Using SceneManager
    • Switching between two Scenes in a SceneManager
    • Using a persistent UI to switch between 3+ Scenes
  • Miscellaneous
    • Getting Keyboard Input
    • Getting Mouse Input
    • Moving the Camera
    • Using Behaviors
    • Using Tags
    • Using Audio -- see [Feature Request] Audio #23
    • Change global rendering settings

Progress on this issue will be tracked in the examples branch. Feel free to suggest tutorials not yet mentioned!

@lucasstarsz lucasstarsz added the enhancement New feature or request label May 23, 2021
lucasstarsz added a commit that referenced this issue May 23, 2021
…ement

# Added SimpleManager for use of FastJ without scenes

Related to #11, #20

## Additions
- Added `SimpleManager` -- a LogicManager implementation that does not use scenes
- Added `hellofastj` example -- Empty Window


## Breaking Changes
- Removed all uses of Scene from InputManager, Keyboard, Mouse
- Removed all uses of Scene from BehaviorManager, TagManager
- Rename existing examples/example mains


## Other Changes
- Added some missing `@Override` annotations
lucasstarsz added a commit that referenced this issue May 25, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue May 27, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
@lucasstarsz lucasstarsz changed the title [Feature Request] Add Examples [Feature Request] Examples May 27, 2021
lucasstarsz added a commit that referenced this issue Jun 6, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue Jun 6, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue Jun 6, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue Jun 6, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue Jun 6, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue Jun 6, 2021
- polygon2d - Creating Polygon2D objects
- text2d - Creating Text2D objects
- model2d - Creating Model2D objects
- modelreadwrite - Reading & Writing Model2D objects
- logging - FastJ logging
- fastjengineconfig - FastJEngine Configuration
lucasstarsz added a commit that referenced this issue Jun 27, 2021
@lucasstarsz lucasstarsz mentioned this issue Jun 27, 2021
lucasstarsz added a commit that referenced this issue Jun 27, 2021
Examples 1

Related to #20 

Adds the following example programs:
- `engineconfig`
- `keyboard`
- `logging`
- `polygon2d`
- `text2d`
- `model2d`
- `modelreadwrite`


## Bug Fixes
_In a list, briefly describe each bug you fixed. A link to the issue/pr where this bug is referenced is highly recommended._
- fixed issue with trying to close display without it being displayed
- fixed issue with `keyChecker` trying to start after shutting down
lucasstarsz added a commit that referenced this issue Jul 12, 2021
@lucasstarsz lucasstarsz added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 16, 2021
@lucasstarsz lucasstarsz pinned this issue Jul 16, 2021
@lucasstarsz lucasstarsz changed the title [Feature Request] Examples Example Programs Jul 16, 2021
@lines-of-codes
Copy link

Hi, I think I'm starting to have some knowledge in FastJ. I would like to help with "
Empty Window using SceneManager" and "Using Audio" examples...

@lucasstarsz
Copy link
Member Author

Sure, go right ahead!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants