Add example transport (#402)

Co-authored-by: NiseVoid <NiseVoid@users.noreply.github.com>

.github/workflows/dependencies.yml

@@ -27,4 +27,5 @@ jobs:
       - name: Check dependencies
         uses: EmbarkStudios/cargo-deny-action@v2
         with:
+          arguments: --all-features --workspace
           command-arguments: -D warnings

.github/workflows/main.yml

@@ -57,10 +57,12 @@ jobs:
         uses: Swatinem/rust-cache@v2
 
       - name: Clippy
-        run: cargo clippy --all-features --benches --tests -- -D warnings
+        run: cargo clippy --workspace --examples --all-features --benches --tests -- -D warnings
 
       - name: Rustdoc
-        run: cargo rustdoc --all-features -- -D warnings
+        run: |
+          cargo rustdoc --all-features -- -D warnings
+          cargo rustdoc -p bevy_replicon_example_backend -- -D warnings
 
   doctest:
     name: Doctest
@@ -76,7 +78,7 @@ jobs:
         uses: Swatinem/rust-cache@v2
 
       - name: Test doc
-        run: cargo test --all-features --doc
+        run: cargo test --workspace --all-features --doc
 
   feature-combinations:
     name: Feature combinations
@@ -121,6 +123,11 @@ jobs:
       - name: Test
         run: cargo tarpaulin --all-features --engine llvm --out lcov --exclude-files benches/*
 
+        # Can't collect coverage from the example backend,
+        # it crashes tarpaulin due to TCP usage.
+      - name: Test backend
+        run: cargo test -p bevy_replicon_example_backend
+
       - name: Upload code coverage results
         if: github.actor != 'dependabot[bot]'
         uses: actions/upload-artifact@v4

Cargo.toml

@@ -24,19 +24,26 @@ include = ["/benches", "/src", "/tests", "/LICENSE*"]
 rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
 all-features = true
 
+[workspace]
+members = ["bevy_replicon_example_backend"]
+
+[workspace.dependencies]
+bevy = { version = "0.15", default-features = false }
+serde = "1.0"
+
 [dependencies]
-bevy = { version = "0.15", default-features = false, features = ["serialize"] }
+bevy = { workspace = true, features = ["serialize"] }
 thiserror = "2.0"
 typeid = "1.0"
 bytes = "1.5"
 bincode = "1.3"
-serde = "1.0"
+serde.workspace = true
 integer-encoding = "4.0"
 ordered-multimap = "0.7"
 bitflags = "2.6"
 
 [dev-dependencies]
-bevy = { version = "0.15", default-features = false, features = [
+bevy = { workspace = true, features = [
   "serialize",
   "bevy_asset",
   "bevy_scene",

README.md

@@ -41,7 +41,7 @@ See also [What kind of networking should X game use?](https://github.com/bevyeng
 
 Check out the [quick start guide](https://docs.rs/bevy_replicon).
 
-For examples navigate to [messaging backends](#messaging-backends) repositories because you will need I/O in order to run them.
+For examples navigate to the [`bevy_replicon_example_backend`](bevy_replicon_example_backend) (because you need I/O in order to run them).
 
 Have any questions? Feel free to ask in the dedicated [`bevy_replicon` channel](https://discord.com/channels/691052431525675048/1090432346907492443) in Bevy's Discord server.
 

bevy_replicon_example_backend/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "bevy_replicon_example_backend"
+version = "0.1.0"
+description = "A simple transport intended only for examples"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+publish = false
+
+[dependencies]
+bevy.workspace = true
+bevy_replicon = { path = "..", default-features = false }
+
+[dev-dependencies]
+bevy = { workspace = true, features = [
+  "bevy_text",
+  "bevy_ui",
+  "bevy_gizmos",
+  "bevy_state",
+  "bevy_window",
+  "x11",
+  "default_font",
+] }
+serde.workspace = true
+clap = { version = "4.1", features = ["derive"] }
+
+[features]
+default = ["client", "server"]
+server = ["bevy_replicon/server"]
+client = ["bevy_replicon/client"]

bevy_replicon_example_backend/README.md

@@ -0,0 +1,12 @@
+# Bevy Replicon Example Backend
+
+A simple TCP backend for running examples, testing backend API and serving as a reference for backend implementation.
+
+> [!WARNING]
+> DO NOT USE this in a real project. Instead, choose a proper backend from [Messaging backends](../README.md#messaging-backends).
+
+To run an [example](examples) use the following command:
+
+```bash
+cargo run -p bevy_replicon_example_backend --example <example name>
+```

bevy_replicon_example_backend/assets/LICENSE

@@ -0,0 +1,92 @@
+This Font Software is licensed under the SIL Open Font License,
+Version 1.1.
+
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font
+creation efforts of academic and linguistic communities, and to
+provide a free and open framework in which fonts may be shared and
+improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply to
+any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software
+components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to,
+deleting, or substituting -- in part or in whole -- any of the
+components of the Original Version, by changing formats or by porting
+the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed,
+modify, redistribute, and sell modified and unmodified copies of the
+Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in
+Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the
+corresponding Copyright Holder. This restriction only applies to the
+primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created using
+the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.