mirror of
https://github.com/godotengine/godot-demo-projects.git
synced 2025-12-16 13:30:07 +01:00
Update README for the new 3.2 branch
This commit is contained in:
@@ -2,10 +2,15 @@
|
|||||||
root = true
|
root = true
|
||||||
|
|
||||||
# Unix-style newlines with a newline ending every file.
|
# Unix-style newlines with a newline ending every file.
|
||||||
[*.cs]
|
[*]
|
||||||
|
charset = utf-8
|
||||||
|
end_of_line = lf
|
||||||
insert_final_newline = true
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.cs]
|
||||||
csharp_space_after_cast = false
|
csharp_space_after_cast = false
|
||||||
indent_size = 4
|
indent_size = 4
|
||||||
|
|
||||||
[*.csproj]
|
[*.csproj]
|
||||||
|
insert_final_newline = false
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|||||||
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@@ -1,9 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: Bug Report
|
name: Bug Report
|
||||||
about: Report a bug with one of the demo projects.
|
about: Report a bug with one of the demo projects.
|
||||||
title: ''
|
title: ""
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ""
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: Feature / Enhancement Request
|
name: Feature / Enhancement Request
|
||||||
about: Adding new features or improving existing ones.
|
about: Adding new features or improving existing ones.
|
||||||
title: ''
|
title: ""
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ''
|
assignees: ""
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ This demo contains a series of tests for the 2D
|
|||||||
physics engine.
|
physics engine.
|
||||||
|
|
||||||
They can be used for different purpose:
|
They can be used for different purpose:
|
||||||
|
|
||||||
- Functional tests to check for regressions and
|
- Functional tests to check for regressions and
|
||||||
behavior of the 2D physics engine
|
behavior of the 2D physics engine
|
||||||
- Performance tests to evaluate performance
|
- Performance tests to evaluate performance
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ This demo contains a series of tests for the 3D
|
|||||||
physics engine.
|
physics engine.
|
||||||
|
|
||||||
They can be used for different purpose:
|
They can be used for different purpose:
|
||||||
|
|
||||||
- Functional tests to check for regressions and
|
- Functional tests to check for regressions and
|
||||||
compare the behavior between physics engines
|
compare the behavior between physics engines
|
||||||
- Performance tests to evaluate and compare
|
- Performance tests to evaluate and compare
|
||||||
|
|||||||
17
README.md
17
README.md
@@ -6,15 +6,17 @@ be used with [Godot Engine](https://godotengine.org), the open source
|
|||||||
|
|
||||||
## Godot versions
|
## Godot versions
|
||||||
|
|
||||||
- The [`master`](https://github.com/godotengine/godot-demo-projects) branch is compatible with the latest stable Godot version (currently 3.2).
|
- The [`master`](https://github.com/godotengine/godot-demo-projects) branch is compatible with the latest stable Godot version (currently 3.3.x).
|
||||||
- If you are using an older version of Godot, use the appropriate branch for your Godot version:
|
- If you are using an older version of Godot, use the appropriate branch for your Godot version:
|
||||||
|
|
||||||
- [`3.1`](https://github.com/godotengine/godot-demo-projects/tree/3.1) branch
|
- [`3.2`](https://github.com/godotengine/godot-demo-projects/tree/3.2)
|
||||||
for Godot 3.1.x.
|
branch for Godot 3.2.x.
|
||||||
- [`3.0`](https://github.com/godotengine/godot-demo-projects/tree/3.0) branch
|
- [`3.1`](https://github.com/godotengine/godot-demo-projects/tree/3.1)
|
||||||
for Godot 3.0.x.
|
branch for Godot 3.1.x.
|
||||||
- [`2.1`](https://github.com/godotengine/godot-demo-projects/tree/2.1) branch
|
- [`3.0`](https://github.com/godotengine/godot-demo-projects/tree/3.0)
|
||||||
for Godot 2.1.x.
|
branch for Godot 3.0.x.
|
||||||
|
- [`2.1`](https://github.com/godotengine/godot-demo-projects/tree/2.1)
|
||||||
|
branch for Godot 2.1.x.
|
||||||
|
|
||||||
## Importing all demos
|
## Importing all demos
|
||||||
|
|
||||||
@@ -40,6 +42,7 @@ desktop. For the best performance, consider downloading the demos.
|
|||||||
- [Source code](https://github.com/godotengine/godot)
|
- [Source code](https://github.com/godotengine/godot)
|
||||||
- [Documentation](http://docs.godotengine.org)
|
- [Documentation](http://docs.godotengine.org)
|
||||||
- [Community hub](https://godotengine.org/community)
|
- [Community hub](https://godotengine.org/community)
|
||||||
|
- [TPS demo](https://github.com/godotengine/tps-demo)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ Check out this demo on the asset library: https://godotengine.org/asset-library/
|
|||||||
The protocol is text based, and composed by a command and possibly multiple payload arguments, each separated by a new line.
|
The protocol is text based, and composed by a command and possibly multiple payload arguments, each separated by a new line.
|
||||||
|
|
||||||
Messages without payload must still end with a newline and are the following:
|
Messages without payload must still end with a newline and are the following:
|
||||||
|
|
||||||
- `J: ` (or `J: <ROOM>`), must be sent by client immediately after connection to get a lobby assigned or join a known one.
|
- `J: ` (or `J: <ROOM>`), must be sent by client immediately after connection to get a lobby assigned or join a known one.
|
||||||
This messages is also sent by server back to the client to notify assigned lobby, or simply a successful join.
|
This messages is also sent by server back to the client to notify assigned lobby, or simply a successful join.
|
||||||
- `I: <ID>`, sent by server to identify the client when it joins a room.
|
- `I: <ID>`, sent by server to identify the client when it joins a room.
|
||||||
@@ -27,6 +28,7 @@ Messages without payload must still end with a newline and are the following:
|
|||||||
When a lobby is sealed, no new client will be able to join, and the lobby will be destroyed (and clients disconnected) after 10 seconds.
|
When a lobby is sealed, no new client will be able to join, and the lobby will be destroyed (and clients disconnected) after 10 seconds.
|
||||||
|
|
||||||
Messages with payload (used to transfer WebRTC parameters) are:
|
Messages with payload (used to transfer WebRTC parameters) are:
|
||||||
|
|
||||||
- `O: <ID>`, used to send an offer.
|
- `O: <ID>`, used to send an offer.
|
||||||
- `A: <ID>`, used to send an answer.
|
- `A: <ID>`, used to send an answer.
|
||||||
- `C: <ID>`, used to send a candidate.
|
- `C: <ID>`, used to send a candidate.
|
||||||
|
|||||||
Reference in New Issue
Block a user