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.

Sign up for GitHub

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

Jump to bottom

docs: Added tutorial for creating a bare Flame project #1376

Merged
merged 5 commits into from
Feb 24, 2022
Merged

docs: Added tutorial for creating a bare Flame project #1376

merged 5 commits into from
Feb 24, 2022

Conversation

st-pasha
Copy link
Contributor

Description

Tutorial for how to start a new Flame project. The tutorial is targeted towards people who may have little or no experience with Flutter or Android development.

Checklist

  • The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
  • I have read the Contributor Guide and followed the process outlined for submitting PRs.
  • (NA) I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • (NA) I have updated/added relevant examples in examples.

Breaking Change

  • No, this is not a breaking change.

spydon
spydon approved these changes Feb 16, 2022
View reviewed changes
Copy link
Member

@spydon spydon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is great to have a bare bones setup tutorial here lile this one, but I think we should focus the rest of the tutorials on https://tutorials.flame-engine.org so I don't think we need a full tutorials section in the docs.

doc/tutorials/bare_flame_game.md Show resolved Hide resolved
@st-pasha
Copy link
Contributor Author

but I think we should focus the rest of the tutorials on https://tutorials.flame-engine.org/ so I don't think we need a full tutorials section in the docs.

What is the benefit of having tutorials on a separate website? I feel they are an important part of the documentation, so should be kept on the main documentation site.

@st-pasha st-pasha changed the title doc: Added tutorial for creating a bare Flame project docs: Added tutorial for creating a bare Flame project Feb 16, 2022
@spydon
Copy link
Member

spydon commented Feb 16, 2022

but I think we should focus the rest of the tutorials on https://tutorials.flame-engine.org/ so I don't think we need a full tutorials section in the docs.

What is the benefit of having tutorials on a separate website? I feel they are an important part of the documentation, so should be kept on the main documentation site.

The tutorial site is much more interactive than the docs are currently, it could be nice to integrate them eventually.

@st-pasha
Copy link
Contributor Author

The tutorial site is much more interactive than the docs are currently, it could be nice to integrate them eventually.

Yes, that was my thinking too. If we could have a running Flame app on tutorials.flame-engine.org, then there is no reason why we can't make the same app run within the docs site, for example via an iframe.

@spydon spydon merged commit 5b58f87 into flame-engine:main Feb 24, 2022
@st-pasha st-pasha deleted the ps/tutorial0 branch February 24, 2022 20:48
st-pasha added a commit to st-pasha/flame that referenced this pull request Mar 9, 2022
@st-pasha
docs: Added tutorial for creating a bare Flame project (flame-engine#…
139c06e 
…1376)
spydon added a commit that referenced this pull request Mar 9, 2022
@st-pasha @erickzanardo
@KurtLa @munsterlander @spydon @luanpotter @allisonryan0002 @alestiago
refactor: Parent change and component removal logic (#1385)
8b9fa35 
* ProcessQueues() method

* Added deadQueue in LifecycleManager

* refactor removeFromParent()

* make shouldRemove non-overridable

* Added lifecycle state "removing"

* prevent double-removal

* shouldRemove can only be set to true

* eliminate _shouldRemove

* rename _dead -> _dying

* added adoption queue

* removed nextParent

* deprecate ComponentSet.clear and .removeAll

* ComponentSet no longer handles removal

* remove usages of shouldRemove

* doc-comments

* onRemove refactor

* cleanup

* remove obsolete paragraph in docs

* rename queue dying -> removals

* feat: update examples dashbook (#1398)

* docs: Added tutorial for creating a bare Flame project (#1376)

* feat: Add missing optional priority to SpriteBodyComponent (#1404)

* Add missing optional priority to SpriteBodyComponent

Gives you the option to set the priority directly when creating the component.

* Add optional parameter priority

Adds priority as an optional parameter

* removed wrong trailing comma

Added a comma at the wrong position.

* feat:  Added getImageLayer to flame_tiled (#1405)

* feat: Create sphinx extension for integrating Flutter apps into the documentation site (#1393)

* feat: adding FlameBloc mixin to allow its usage with enhanced FlameGame classes (#1399)

* feat: adding FlameBloc mixin to allow its usage with enhanced FlameGame classes

* fixing tests

* Apply suggestions from code review

Co-authored-by: Lukas Klingsbo <me@lukas.fyi>
Co-authored-by: Pasha Stetsenko <stpasha@google.com>
Co-authored-by: Luan Nico <luanpotter27@gmail.com>

Co-authored-by: Lukas Klingsbo <me@lukas.fyi>
Co-authored-by: Pasha Stetsenko <stpasha@google.com>
Co-authored-by: Luan Nico <luanpotter27@gmail.com>

* refactor: Organize tests in the game/ folder (#1403)

* position_type_test

* detectors_test

* reformat projections_test

* Reorganize tests in projector_test

* review flame_game_test

* move some cameratests

* created viewport_test file

* reformat camera tests

* feat: Add missing optional priority to SpriteBodyComponent (#1404)

* Add missing optional priority to SpriteBodyComponent

Gives you the option to set the priority directly when creating the component.

* Add optional parameter priority

Adds priority as an optional parameter

* removed wrong trailing comma

Added a comma at the wrong position.

* feat:  Added getImageLayer to flame_tiled (#1405)

* feat: Create sphinx extension for integrating Flutter apps into the documentation site (#1393)

Co-authored-by: KurtLa <KurtLa@users.noreply.github.com>
Co-authored-by: Munsterlander <munsterlander@users.noreply.github.com>
Co-authored-by: Erick <erickzanardoo@gmail.com>

* feat: improving generics on position body component (#1397)

* chore(release): publish packages (#1407)

- flame@1.1.0-releasecandidate.1
 - flame_bloc@1.2.0-releasecandidate.1
 - flame_rive@1.1.0-releasecandidate.1
 - flame_test@1.2.0-releasecandidate.1
 - flame_tiled@1.3.0-releasecandidate.1

* chore: fixing pub deps to allow publish (#1408)

* chore(release): publish packages

 - flame@1.1.0-releasecandidate.1
 - flame_bloc@1.2.0-releasecandidate.1
 - flame_rive@1.1.0-releasecandidate.1
 - flame_test@1.2.0-releasecandidate.1
 - flame_tiled@1.3.0-releasecandidate.1

* chore: fixing deps to enable pub publish

* fixing vector math version

* chore(flame_forge2d): export all files in barrel file (#1409)

* chore(release): publish packages (#1410)

- flame_forge2d@0.9.0-releasecandidate.1

* chore: commented out PR template sections (#1412)

* feat: Make ContactCallback begin end methods optional overrides (#1415)

* feat: made begin and end optional overrides

* chore: removed unecessary end override

* feat: Camera as a component (#1355)

* feat(collision detection)!: Use a broadphase to make collision detection more efficient (#1252)

* fix: PositionBodyComponent had an async onMount, without needing (#1424)

* fix: Fix collision detection comments and typo (#1422)

* Fix collision detection comments and typo

* Update packages/flame/lib/src/collisions/collision_callbacks.dart

Co-authored-by: Pasha Stetsenko <stpasha@google.com>

* Update doc/flame/collision_detection.md

Co-authored-by: Pasha Stetsenko <stpasha@google.com>

Co-authored-by: Pasha Stetsenko <stpasha@google.com>

* feat: adding has mounted to component (#1418)

* feat: adding has mounted to component

* feat: pr suggestions

* feat: improving hasMounted

* feat: renaming hasMounted to mounted

* feat: pr suggestion

* chore(release): publish packages (#1427)

- flame_svg@1.1.0-releasecandidate.1
 - flame@1.1.0-releasecandidate.2
 - flame_bloc@1.2.0-releasecandidate.2
 - flame_forge2d@0.9.0-releasecandidate.2
 - flame_rive@1.1.0-releasecandidate.2
 - flame_test@1.2.0-releasecandidate.2
 - flame_tiled@1.3.0-releasecandidate.2

* fix a test

* fix broken merge

* rename parent->owner in LifecycleManager

* update doc-comment

Co-authored-by: Erick <erickzanardoo@gmail.com>
Co-authored-by: KurtLa <KurtLa@users.noreply.github.com>
Co-authored-by: Munsterlander <munsterlander@users.noreply.github.com>
Co-authored-by: Lukas Klingsbo <me@lukas.fyi>
Co-authored-by: Luan Nico <luanpotter27@gmail.com>
Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com>
Co-authored-by: Alejandro Santiago <dev@alestiago.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spydon spydon spydon approved these changes

@erickzanardo erickzanardo erickzanardo approved these changes

@luanpotter luanpotter Awaiting requested review from luanpotter

@renancaraujo renancaraujo Awaiting requested review from renancaraujo

@wolfenrain wolfenrain Awaiting requested review from wolfenrain

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@st-pasha @spydon @erickzanardo