docs: mention screenshot.png

AmbientRun · Nov 23, 2023 · ca49cf4 · ca49cf4
1 parent 6135f2b
commit ca49cf4
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 2 deletions.
diff --git a/docs/src/reference/distributing.md b/docs/src/reference/distributing.md
@@ -16,6 +16,8 @@ Package "my-project" deployed successfully!
 
 This will package and upload your creation to the platform. The web URL in the output can be used to browse your game or asset. If you're on a WebGPU enabled browser, the game can be played directly on the website. Any content upload to the Ambient platform is subject to our [terms of services](https://www.ambient.run/terms-of-service).
 
+If a `screenshot.png` is present in the package's directory, it will be used as the game's thumbnail on the Ambient website. We recommend you include one.
+
 In the case your package is a game, it can be played directly on the website (if you're on a WebGPU enabled browser). Additionally, game servers will automatically be spun up when someone wants to play your game.
 
 ## Putting your game on itch.io

diff --git a/docs/src/reference/networking.md b/docs/src/reference/networking.md
@@ -4,7 +4,7 @@ Networking is a critical component of Ambient, as it enables communication betwe
 
 ## Protocol
 
-Currently, the Ambient runtime only supports desktop clients and uses QUIC through the `quinn` library as its communication protocol. We are actively working on web deployments and plan to use WebTransport as soon as possible.
+Currently, the Ambient runtime supports both desktop and web clients, using QUIC through the `quinn` library/WebTransport through `h3-webtransport` respectively as its communication protocol.
 
 The HTTP (TCP) port is `8999`, and the QUIC (UDP) port is `9000`.
 

diff --git a/docs/src/reference/package.md b/docs/src/reference/package.md
@@ -2,6 +2,8 @@
 
 All Ambient packages must have an `ambient.toml` manifest that describes their functionality. This format is in flux, but is inspired by Rust's `Cargo.toml`.
 
+Next to the `ambient.toml`, other files may be present. A `screenshot.png` can be used to provide a thumbnail for the package on the Ambient website. A `README.md` can be used to provide a description of the package on the Ambient website.
+
 ## Reference
 
 - `SnakeCaseIdentifier`s are snake-case ASCII identifiers (as a string)

diff --git a/docs/src/tutorials/game/7_deploying.md b/docs/src/tutorials/game/7_deploying.md
@@ -13,6 +13,8 @@ ambient deploy
 Once your game is deployed, you can just go to the web URL provided and play it from there. You can send the URL
 to a friend, and they can join you there as well!
 
+If a `screenshot.png` is present in the package's directory, it will be used as the game's thumbnail on the Ambient website. We recommend you include one.
+
 > **Tip**: Deploying with `ambient deploy` will deploy to the Ambient servers. For more deployment options, including your own game servers, see the [reference documentation on distribution](../../reference/distributing.md).
 
 ## [⇾ Chapter 8: Modding](./8_modding.md)
diff --git a/docs/src/tutorials/game/8_modding.md b/docs/src/tutorials/game/8_modding.md
@@ -42,7 +42,7 @@ content = { type = "Mod", for_playables = ["the_id_of_your_game_from_its_ambient
 my_game = { deployment = "LATEST_DEPLOYMENT_ID" }
 ```
 
-You can now edit and run the code in `src/`, as per usual. Once you're happy with your mod, you can deploy it with `ambient deploy` (just like we did with the game).
+You can now edit and run the code in `src/`, as per usual. Once you're happy with your mod, you can deploy it with `ambient deploy`, just like with the game. Providing a `screenshot.png` is recommended to make sure your mod stands out.
 
 Remember to comment out the `my_game = ..` line before deploying.