Skip to content

Commit 8c9d6f0

Browse files
photonstormphotonstorm
committed
Created v4 change log and updated readme
1 parent 59b4106 commit 8c9d6f0

File tree

2 files changed

+76
-72
lines changed

2 files changed

+76
-72
lines changed

‎README.md

+6-72
Original file line numberDiff line numberDiff line change
@@ -22,77 +22,11 @@ You are looking at the Beta Release of Phaser v4. There are large internal diffe
2222

2323
Please only use this release if you wish to help beta test Phaser v4.
2424

25-
Phaser v4 contains Phaser Beam, our brand-new and highly efficient WebGL renderer. Virtually the entire renderer from v3 has been replaced and this transition will be documented in its own Change Log.
26-
27-
Other changes also include the following:
28-
29-
✔️ We have removed `Phaser.Struct.Set` and replaced it with a regular JS `Set` instance. This means methods like `iterateLocal` are gone.
30-
✔️ We have removed the `Create.GenerateTexture` function and all of the Create Palettes and the `create` folder.
31-
✔️ `TextureManager.generate` has been removed as a result of the GenerateTexture removal.
32-
✔️ We have removed the `phaser-ie9.js` entry-point.
33-
✔️ We have removed `Math.SinCosTableGenerator`.
34-
✔️ We have removed the following polyfills: Array.forEach, Array.isArray, AudioContextMonkeyPatch, console, Math.trunc, performance.now, requestAnimationFrame and Uint32Array.
35-
✔️ We have removed the Facebook Plugin detection constants from the core library.
36-
✔️ We have removed the Camera3D Plugin.
37-
✔️ We have removed the Layer3D Plugin.
38-
✔️ The `Geom.Point` class and all related functions will be removed. All functionality for this can be found in the existing Vector2 math classes. All Geometry classes that currently create and return Point objects will be updated to return Vector2 objects instead.
39-
* We are removing `Phaser.Struct.Map` and replacing it with a regular JS `Map` instance. This means methods like `contains` and `setAll` will be gone.
40-
* The Spine 3 and Spine 4 plugins will no longer be updated. You should now use the official Phaser Spine plugin created by Esoteric Software.
41-
42-
`Point.Ceil` = `Vector2.ceil`
43-
`Point.Floor` = `Vector2.floor`
44-
`Point.Clone` = `Vector2.clone`
45-
`Point.CopyFrom(src,dest)` = `dest.copy(src)`
46-
`Point.Equals` = `Vector2.equals`
47-
`Point.GetCentroid` = `Math.GetCentroid`
48-
`Point.GetMagnitude` = `Vector2.length`
49-
`Point.GetMagnitudeSq` = `Vector2.lengthSq`
50-
`Point.Invert` = `Vector2.invert`
51-
`Point.Negative` = `Vector2.negate`
52-
`Point.SetMagnitude` = `Vector2.setLength`
53-
`Point.Project` = `Vector2.project`
54-
`Point.ProjectUnit` = `Vector2.projectUnit`
55-
`Point.Interpolate` = `Math.LinearXY`
56-
`Point.GetRectangleFromPoints` = `Math.GetVec2Bounds`
57-
58-
* `Vector2.ceil` is a new method that will apply Math.ceil to the x and y components of the vector. Use as a replacement for `Geom.Point.Ceil`.
59-
* `Vector2.floor` is a new method that will apply Math.floor to the x and y components of the vector. Use as a replacement for `Geom.Point.Floor`.
60-
* `Vector2.invert` is a new method that will swap the x and y components of the vector. Use as a replacement for `Geom.Point.Invert`.
61-
* `Vector2.projectUnit` is a new method that will calculate the vector projection onto a non-zero target vector. Use as a replacement for `Geom.Point.ProjectUnit`.
62-
* `Math.GetCentroid` is a new function that will get the centroid, or geometric center, of a plane figure from an array of Vector2 like objects. Use as a replacement for `Geom.Point.GetCentroid`.
63-
* `Math.GetVec2Bounds` is a new function that will get the AABB bounds as a Geom.Rectangle from an array of Vector2 objects. Use as a replacement for `Geom.Point.GetRectangleFromPoints`.
64-
* `Math.TAU` is now actually the value of tau! (i.e. PI * 2) instead of being PI / 2.
65-
* `Math.PI2` has been removed. You can use `Math.TAU` instead. All internal use of PI2 has been replaced with TAU.
66-
* `Math.PI_OVER_2` is a new constant for PI / 2 and all internal use of TAU has been updated to this new constant.
67-
* `Geom.Circle.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
68-
* The functions `Geom.Circle.CircumferencePoint`, `Circle.CircumferencePoint`, `Circle.GetPoint`, `Circle.GetPoints`, `Circle.OffsetPoint` and `Circle.Random` all now take and in some cases return Vector2 instances instead of Point objects.
69-
* `Geom.Ellipse.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
70-
* The functions `Geom.Ellipse.CircumferencePoint`, `Ellipse.CircumferencePoint`, `Ellipse.GetPoint`, `Ellipse.GetPoints`, `Ellipse.OffsetPoint` and `Ellipse.Random` all now take and in some cases return Vector2 instances instead of Point objects.
71-
* `Geom.Line.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
72-
* The functions `Geom.Line.GetEasedPoint`, `Line.GetMidPoint`, `Line.GetNearestPoint`, `Line.GetNormal`, `Line.GetPoint`, `Line.GetPoints`, `Line.Random` and `Line.RotateAroundPoint` all now take and in some cases return Vector2 instances instead of Point objects.
73-
* The `Geom.Polygon.getPoints` method now returns Vector2 objects instead of Point.
74-
* The functions `Geom.Polygon.ContainsPoint` and `Polygon.GetPoints` all now take and in some cases return Vector2 instances instead of Point objects.
75-
* `Geom.Rectangle.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
76-
* The functions `Geom.Rectangle.ContainsPoint`, `Rectangle.GetCenter`, `Rectangle.GetPoint`, `Rectangle.GetPoints`, `Rectangle.GetSize`, `Rectangle.MarchingAnts`, `Rectangle.MergePoints`, `Rectangle.OffsetPoint`, `Rectangle.PerimeterPoint`, `Rectangle.Random` and `Rectangle.RandomOutside` all now take and in some cases return Vector2 instances instead of Point objects.
77-
* `Geom.Triangle.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
78-
* The functions `Geom.Triangle.Centroid`, `Triangle.CircumCenter`, `Triangle.ContainsArray`, `Triangle.ContainsPoint`, `Triangle.GetPoint`, `Triangle.GetPoints`, `Triangle.InCenter`, `Triangle.Random` and `Triangle.RotateAroundPoint` all now take and in some cases return Vector2 instances instead of Point objects.
79-
* `DynamicTexture` and `RenderTexture` must call `render()` to actually draw.
80-
81-
v4.0.0 Beta 2 Updates:
82-
83-
* Better roundPixels handling via bias.
84-
* UUIDs for DynamicTexture names.
85-
* Masks work (again). Big feature!
86-
* DynamicTexture can resize immediately after creation.
87-
* Fix shader compilation issues on diverse systems.
88-
* Shapes/Graphics should work again in Firefox.
89-
* Issues with inTexDatum should be eliminated in affected Linux systems.
90-
* Fix Extern and extend its rendering potential (see Beam Examples).
91-
* TileSprite now assigns default dimensions to each dimension separately.
92-
* BaseFilterShader now accesses loaded shader cache keys correctly.
93-
94-
95-
## Installing Phaser from NPM
25+
Phaser v4 contains Phaser Beam, our brand-new and highly efficient WebGL renderer. The entire renderer from v3 has been replaced.
26+
27+
We also took this opportunity to make other Quality-of-Life updates internally, which you can find detailed in [this change log](changelog/4.0/CHANGELOG-v4.0.0.md).
28+
29+
## Installing Phaser 4 Beta from NPM
9630

9731
Install via [npm](https://www.npmjs.com/package/phaser):
9832

@@ -135,7 +69,7 @@ Cheers,
13569

13670
Powered by coffee, anime, pixels and love.
13771

138-
The Phaser logo and characters are © 2011 - 2024 Phaser Studio Inc.
72+
The Phaser logo and characters are © 2011 - 2025 Phaser Studio Inc.
13973

14074
All rights reserved.
14175

‎changelog/4.0/CHANGELOG-v4.0.0.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Version 4.0.0 - in dev
2+
3+
Phaser v4 contains Phaser Beam, our brand-new and highly efficient WebGL renderer. The entire renderer from Phaser +v3 has been replaced.
4+
5+
Other changes include the following:
6+
7+
✔️ We have removed `Phaser.Struct.Set` and replaced it with a regular JS `Set` instance. This means methods like `iterateLocal` are gone.
8+
✔️ We have removed the `Create.GenerateTexture` function and all of the Create Palettes and the `create` folder.
9+
✔️ `TextureManager.generate` has been removed as a result of the GenerateTexture removal.
10+
✔️ We have removed the `phaser-ie9.js` entry-point.
11+
✔️ We have removed `Math.SinCosTableGenerator`.
12+
✔️ We have removed the following polyfills: Array.forEach, Array.isArray, AudioContextMonkeyPatch, console, Math.trunc, performance.now, requestAnimationFrame and Uint32Array.
13+
✔️ We have removed the Facebook Plugin detection constants from the core library.
14+
✔️ We have removed the Camera3D Plugin.
15+
✔️ We have removed the Layer3D Plugin.
16+
✔️ The `Geom.Point` class and all related functions will be removed. All functionality for this can be found in the existing Vector2 math classes. All Geometry classes that currently create and return Point objects will be updated to return Vector2 objects instead.
17+
* We are removing `Phaser.Struct.Map` and replacing it with a regular JS `Map` instance. This means methods like `contains` and `setAll` will be gone.
18+
* The Spine 3 and Spine 4 plugins will no longer be updated. You should now use the official Phaser Spine plugin created by Esoteric Software.
19+
20+
`Point.Ceil` = `Vector2.ceil`
21+
`Point.Floor` = `Vector2.floor`
22+
`Point.Clone` = `Vector2.clone`
23+
`Point.CopyFrom(src,dest)` = `dest.copy(src)`
24+
`Point.Equals` = `Vector2.equals`
25+
`Point.GetCentroid` = `Math.GetCentroid`
26+
`Point.GetMagnitude` = `Vector2.length`
27+
`Point.GetMagnitudeSq` = `Vector2.lengthSq`
28+
`Point.Invert` = `Vector2.invert`
29+
`Point.Negative` = `Vector2.negate`
30+
`Point.SetMagnitude` = `Vector2.setLength`
31+
`Point.Project` = `Vector2.project`
32+
`Point.ProjectUnit` = `Vector2.projectUnit`
33+
`Point.Interpolate` = `Math.LinearXY`
34+
`Point.GetRectangleFromPoints` = `Math.GetVec2Bounds`
35+
36+
* `Vector2.ceil` is a new method that will apply Math.ceil to the x and y components of the vector. Use as a replacement for `Geom.Point.Ceil`.
37+
* `Vector2.floor` is a new method that will apply Math.floor to the x and y components of the vector. Use as a replacement for `Geom.Point.Floor`.
38+
* `Vector2.invert` is a new method that will swap the x and y components of the vector. Use as a replacement for `Geom.Point.Invert`.
39+
* `Vector2.projectUnit` is a new method that will calculate the vector projection onto a non-zero target vector. Use as a replacement for `Geom.Point.ProjectUnit`.
40+
* `Math.GetCentroid` is a new function that will get the centroid, or geometric center, of a plane figure from an array of Vector2 like objects. Use as a replacement for `Geom.Point.GetCentroid`.
41+
* `Math.GetVec2Bounds` is a new function that will get the AABB bounds as a Geom.Rectangle from an array of Vector2 objects. Use as a replacement for `Geom.Point.GetRectangleFromPoints`.
42+
* `Math.TAU` is now actually the value of tau! (i.e. PI * 2) instead of being PI / 2.
43+
* `Math.PI2` has been removed. You can use `Math.TAU` instead. All internal use of PI2 has been replaced with TAU.
44+
* `Math.PI_OVER_2` is a new constant for PI / 2 and all internal use of TAU has been updated to this new constant.
45+
* `Geom.Circle.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
46+
* The functions `Geom.Circle.CircumferencePoint`, `Circle.CircumferencePoint`, `Circle.GetPoint`, `Circle.GetPoints`, `Circle.OffsetPoint` and `Circle.Random` all now take and in some cases return Vector2 instances instead of Point objects.
47+
* `Geom.Ellipse.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
48+
* The functions `Geom.Ellipse.CircumferencePoint`, `Ellipse.CircumferencePoint`, `Ellipse.GetPoint`, `Ellipse.GetPoints`, `Ellipse.OffsetPoint` and `Ellipse.Random` all now take and in some cases return Vector2 instances instead of Point objects.
49+
* `Geom.Line.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
50+
* The functions `Geom.Line.GetEasedPoint`, `Line.GetMidPoint`, `Line.GetNearestPoint`, `Line.GetNormal`, `Line.GetPoint`, `Line.GetPoints`, `Line.Random` and `Line.RotateAroundPoint` all now take and in some cases return Vector2 instances instead of Point objects.
51+
* The `Geom.Polygon.getPoints` method now returns Vector2 objects instead of Point.
52+
* The functions `Geom.Polygon.ContainsPoint` and `Polygon.GetPoints` all now take and in some cases return Vector2 instances instead of Point objects.
53+
* `Geom.Rectangle.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
54+
* The functions `Geom.Rectangle.ContainsPoint`, `Rectangle.GetCenter`, `Rectangle.GetPoint`, `Rectangle.GetPoints`, `Rectangle.GetSize`, `Rectangle.MarchingAnts`, `Rectangle.MergePoints`, `Rectangle.OffsetPoint`, `Rectangle.PerimeterPoint`, `Rectangle.Random` and `Rectangle.RandomOutside` all now take and in some cases return Vector2 instances instead of Point objects.
55+
* `Geom.Triangle.getPoint`, `getPoints` and `getRandomPoint` now all return Vector2 objects instead of Point.
56+
* The functions `Geom.Triangle.Centroid`, `Triangle.CircumCenter`, `Triangle.ContainsArray`, `Triangle.ContainsPoint`, `Triangle.GetPoint`, `Triangle.GetPoints`, `Triangle.InCenter`, `Triangle.Random` and `Triangle.RotateAroundPoint` all now take and in some cases return Vector2 instances instead of Point objects.
57+
* `DynamicTexture` and `RenderTexture` must call `render()` to actually draw.
58+
59+
v4.0.0 Beta 2 Updates:
60+
61+
* Better roundPixels handling via bias.
62+
* UUIDs for DynamicTexture names.
63+
* Masks work (again). Big feature!
64+
* DynamicTexture can resize immediately after creation.
65+
* Fix shader compilation issues on diverse systems.
66+
* Shapes/Graphics should work again in Firefox.
67+
* Issues with inTexDatum should be eliminated in affected Linux systems.
68+
* Fix Extern and extend its rendering potential (see Beam Examples).
69+
* TileSprite now assigns default dimensions to each dimension separately.
70+
* BaseFilterShader now accesses loaded shader cache keys correctly.

0 commit comments

Comments
 (0)