1-6 player splitscreen multiplayer addon
| -rw-r--r-- | README.md | 42 | ||||
| -rw-r--r-- | addons/splitter/README.md | 40 | ||||
| -rw-r--r-- | addons/splitter/package.json | 2 |
3 files changed, 82 insertions, 2 deletions
@@ -1,7 +1,7 @@ # splitter [](https://godotengine.org "Made with godot") -](https://www.npmjs.com/package/@bendn/remap) +[](https://www.npmjs.com/package/@bendn/remap) <a href='https://ko-fi.com/bendn' title='Buy me a coffee' target='_blank'><img height='28' src='https://storage.ko-fi.com/cdn/brandasset/kofi_button_red.png' alt='Buy me a coffee'> </a> Small addon for multiplayer splitscreen @@ -21,3 +21,43 @@ func _ready() -> void: cam = Camera3D.new() join().add_child(cam) ``` + +## Installation + +<details open> + <summary><h3>With the Godot Package Manager</h3></summary> + +> **Note** The information here may not be up to date. For most up to date information, see [gpm#using-packages](https://github.com/godot-package-manager#using-packages-quickstart) + +> **Warning** This addon is not compatible with being used as a sub addon(a addon to another addon), as it uses classes. + +This addon is installable via the [gpm](https://github.com/godot-package-manager). +To install, create a [`godot.package`](https://github.com/godot-package-manager#godotpackage) file. +It should look something like this. + +```jsonc +packages: { + @bendn/splitter: 1.0.1 // this is the package version. +} +``` + +Then download the [latest version](https://github.com/godot-package-manager/cli/releases/latest) of the [cli](https://github.com/godot-package-manager/cli#installation), move the executable to your `PATH` as `gpm` (`wget "https://github.com/godot-package-manager/cli/releases/latest/download/godot-package-manager.x86_64" -O /bin/gpm`). + +And finally, to download[^1]: + +```bash +gpm update # in the same dir as your godot.package +# or, if in a different dir, +# gpm update --config-file path-to-godot.package +``` + +</details> +<details> + <summary><h3>Manually<h3></summary> + +- Download the repo (`wget https://github.com/bend-n/splitter/archive/refs/heads/main.zip && unzip main.zip`). +- Move the `splitter-main/addons/splitter` folder into your `addons` folder (`mkdir addons && mv splitter-main/addons/splitter addons/`) + +</details> + +[^1]: [Usage instructions for the cli](https://github.com/godot-package-manager/cli#usage) diff --git a/addons/splitter/README.md b/addons/splitter/README.md index 0bc0ae8..6ed92bc 100644 --- a/addons/splitter/README.md +++ b/addons/splitter/README.md @@ -20,3 +20,43 @@ func _ready() -> void: cam = Camera3D.new() join().add_child(cam) ``` + +## Installation + +<details open> + <summary><h3>With the Godot Package Manager</h3></summary> + +> **Note** The information here may not be up to date. For most up to date information, see [gpm#using-packages](https://github.com/godot-package-manager#using-packages-quickstart) + +> **Warning** This addon is not compatible with being used as a sub addon(a addon to another addon), as it uses classes. + +This addon is installable via the [gpm](https://github.com/godot-package-manager). +To install, create a [`godot.package`](https://github.com/godot-package-manager#godotpackage) file. +It should look something like this. + +```jsonc +packages: { + @bendn/splitter: 1.0.1 // this is the package version. +} +``` + +Then download the [latest version](https://github.com/godot-package-manager/cli/releases/latest) of the [cli](https://github.com/godot-package-manager/cli#installation), move the executable to your `PATH` as `gpm` (`wget "https://github.com/godot-package-manager/cli/releases/latest/download/godot-package-manager.x86_64" -O /bin/gpm`). + +And finally, to download[^1]: + +```bash +gpm update # in the same dir as your godot.package +# or, if in a different dir, +# gpm update --config-file path-to-godot.package +``` + +</details> +<details> + <summary><h3>Manually<h3></summary> + +- Download the repo (`wget https://github.com/bend-n/splitter/archive/refs/heads/main.zip && unzip main.zip`). +- Move the `splitter-main/addons/splitter` folder into your `addons` folder (`mkdir addons && mv splitter-main/addons/splitter addons/`) + +</details> + +[^1]: [Usage instructions for the cli](https://github.com/godot-package-manager/cli#usage) diff --git a/addons/splitter/package.json b/addons/splitter/package.json index e1b2041..bd451ae 100644 --- a/addons/splitter/package.json +++ b/addons/splitter/package.json @@ -1,6 +1,6 @@ { "name": "@bendn/splitter", - "version": "1.0.1", + "version": "1.0.2", "description": "small addon for splitscreen multiplayer", "main": "screen.gd", "scripts": { |