phaserjs / phaserjs/phaser

Docs error in "Scene systems and plugins"

Open Beginner friendly
#7,127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

📖 Docs
Dominant language
JavaScript
Stars
40.3k
Forks
7.2k
PR merge metrics
No merged PRs in 30d

Description

https://docs.phaser.io/phaser/concepts/scenes#scene-systems-and-plugins

Any extra scene plugins you've added in the game config with { start: true } or any { mapping: … } are also default plugins.

etc. is incorrect. The correct description is

Any scene plugins added to the game config are default plugins and will be installed in each scene unless excluded in the scene config.

Custom scene plugins can be excluded like

new Phaser.Scene({
  // Phaser's default scene plugins only.
  plugins: Phaser.Plugins.DefaultPlugins.DefaultScene
});

Phaser default scene plugins can be excluded like

new Phaser.Scene({
  // "DataManagerPlugin", "Loader", and "LightsPlugin" are omitted.
  plugins: ["Clock", "InputPlugin", "TweenManager"],
});

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Phaser documentation page at the Scene systems and plugins section and locate its source in the documentation repository. Replace the incorrect description with the provided wording and examples, then verify the rendered page accurately explains default and excluded scene plugins.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.