Add Colyseus example

.editorconfig

@@ -0,0 +1,6 @@
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4

CONTRIBUTING.md

@@ -3,6 +3,6 @@
 ## Templating README files
 
 ```
-./scripts/template.sh
+./_internal/scripts/template.sh
 ```
 

_internal/templater/src/main.rs

@@ -73,7 +73,9 @@ impl std::fmt::Display for ConfigMetaLanguage {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 enum ConfigMetaNetworking {
+    WebRTC,
     SocketIo,
+    Colyseus,
     GodotHLMultiplayer,
     FishNet,
     UnrealReplication,
@@ -82,7 +84,9 @@ enum ConfigMetaNetworking {
 impl ConfigMetaNetworking {
     fn url(&self) -> &'static str {
         match self {
+            Self::WebRTC => "https://webrtc.org",
             Self::SocketIo => "https://socket.io",
+            Self::Colyseus => "https://github.com/rivet-gg/plugin-colyseus-server'",
             Self::GodotHLMultiplayer => "https://docs.godotengine.org/en/stable/tutorials/networking/high_level_multiplayer.html",
             Self::FishNet => "https://fish-networking.gitbook.io/docs/",
             Self::UnrealReplication => "https://docs.unrealengine.com/en-US/Gameplay/Networking/Actors/Replication/index.html",
@@ -93,7 +97,9 @@ impl ConfigMetaNetworking {
 impl std::fmt::Display for ConfigMetaNetworking {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self {
+            Self::WebRTC => write!(f, "WebRTC"),
             Self::SocketIo => write!(f, "Socket.IO"),
+            Self::Colyseus => write!(f, "Colyseus"),
             Self::GodotHLMultiplayer => write!(f, "High-Level Multiplayer"),
             Self::FishNet => write!(f, "Fish-Networking"),
             Self::UnrealReplication => write!(f, "Actor Replication"),

_internal/templater/tpl/README.md.tera

@@ -18,14 +18,14 @@
 - [{{ feature.name }}]({{ feature.url }})
 {% endfor %}
 
-## Developing Locally
+## Running locally
 
 1. [Clone the GitHub repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
 2. Open this folder
 3. Run: `rivet init`
 4. Run `yarn start`
 
-## Deploying
+## Deploying to Rivet
 
 [Documentation]({{ deploy_docs_url }})
 

c/coredump/README.md

@@ -13,14 +13,14 @@
 - [🌐 Dynamic Servers](https://rivet.gg/docs/dynamic-servers)
 
 
-## Developing Locally
+## Running locally
 
 1. [Clone the GitHub repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
 2. Open this folder
 3. Run: `rivet init`
 4. Run `yarn start`
 
-## Deploying
+## Deploying to Rivet
 
 [Documentation](https://rivet.gg/learn/html5/tutorials/crash-course#step-3-publish-your-game)
 

html5/colyseus/.dockerignore

@@ -0,0 +1,9 @@
+node_modules
+npm-debug.log
+lib
+*.js
+Dockerfile
+
+### Rivet ###
+.rivet/
+.env

html5/colyseus/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Debug",
+			"type": "pwa-node",
+			"request": "launch",
+			"runtimeExecutable": "node",
+			"runtimeArgs": [
+				"--nolazy",
+				"-r",
+				"ts-node/register/transpile-only"
+			],
+			"args": ["src/index.ts"],
+			"cwd": "${workspaceRoot}",
+			"internalConsoleOptions": "openOnSessionStart",
+			"resolveSourceMapLocations": [
+				"${workspaceFolder}/**",
+				"!**/node_modules/**"
+			],
+			"skipFiles": ["<node_internals>/**", "node_modules/**"]
+		}
+	]
+}

html5/colyseus/Dockerfile

@@ -0,0 +1,17 @@
+# === Build ===
+FROM node:16-alpine as build
+WORKDIR /app
+COPY ./package.json ./package-lock.json /app/
+RUN npm install
+COPY . .
+RUN npm run build
+
+# === Run ===
+FROM node:16-alpine
+WORKDIR /app
+# Enables uWebSockets to run on Alpine Linux
+RUN apk add --no-cache libc6-compat && ln -s /lib/libc.musl-x86_64.so.1 /lib/ld-linux-x86-64.so.2
+COPY --from=build /app/package.json /app/package-lock.json /app/
+RUN npm install --production
+COPY --from=build /app/lib/ /app/lib/
+CMD node lib/index.js

html5/colyseus/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rivet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

html5/colyseus/README.md

@@ -0,0 +1,27 @@
+# Colyseus
+
+
+
+
+
+|  Language | Networking |
+|  --- | --- |
+|  [TypeScript](https://www.typescriptlang.org) | [Colyseus](https://github.com/rivet-gg/plugin-colyseus-server') |
+
+**Rivet Features**
+
+- [♟️ Matchmaker](https://rivet.gg/docs/matchmaker)
+- [🌐 Dynamic Servers](https://rivet.gg/docs/dynamic-servers)
+
+
+## Running locally
+
+1. [Clone the GitHub repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
+2. Open this folder
+3. Run: `rivet init`
+4. Run `yarn start`
+
+## Deploying to Rivet
+
+[Documentation](https://rivet.gg/learn/html5/tutorials/crash-course#step-3-publish-your-game)
+

html5/colyseus/example.toml

@@ -0,0 +1,15 @@
+[display]
+title = "Colyseus"
+description = """
+This repository provides examples of running Colyseus with the Rivet plugin.
+
+[**Live demo**](https://colyseus.rivet.game/)
+""""
+
+[meta]
+engine = "HTML5"
+language = "TypeScript"
+networking = "Colyseus"
+features = ["Matchmaker", "DynamicServers"]
+
+