From 4ff20e87b6235cf66cabdc9a8361d49a7d23d8d5 Mon Sep 17 00:00:00 2001 From: Nebual Date: Mon, 7 Jun 2021 16:06:52 -0700 Subject: [PATCH] Add support for minimal-extended modular gamemode --- AddonInfo.cs | 31 +++++++++++++++++++++++++++++++ README.md | 28 ++++++++++++++++++++++++++++ unpack-assets.bat | 1 + 3 files changed, 60 insertions(+) create mode 100644 AddonInfo.cs create mode 100755 README.md create mode 100755 unpack-assets.bat diff --git a/AddonInfo.cs b/AddonInfo.cs new file mode 100644 index 0000000..78ae430 --- /dev/null +++ b/AddonInfo.cs @@ -0,0 +1,31 @@ +using System; +using System.Collections.Generic; +using MinimalExtended; +using Sandbox; + +namespace Wirebox +{ + [Library("wirebox")] + public class AddonInfo : IAddonInfo + { + public string Name => "WireBox"; + + public string Description => "Wiremod for S&Box"; + + public string Author => "Wireteam"; + + public double Version => 0.1; + + public List Dependencies => new() + { + new AddonDependency() + { + Name = "Sandbox", + MinVersion = 1.0 + } + }; + + // No main class as it should be instantiated by the Entities/Tools (so far) + public Type MainClass => null; + } +} diff --git a/README.md b/README.md new file mode 100755 index 0000000..bd9eb22 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Wiremod for S&box + +## Current status + +Very early WIP (as is S&box itself). There's basic wiring of thrusters/lights to buttons. +Players/Testers: there's nothing to do yet + +## Setup + +S&box is currently focused around 'Gamemodes', not modular addons, +however [[A]lex is working on a modular Gamemode framework](https://github.com/Ceveos/minimal-extended) which might work for us. There's thus two install approaches: + +### Using minimal-extended modular gamemode framework +``` +cd steamapps/common/sbox/addons +git clone https://github.com/Ceveos/minimal-extended.git +cd minimal-extended/code/addons +git clone https://github.com/wiremod/wirebox.git +cd wirebox +./unpack-assets.bat +``` + +Alternatively, use the latest Github Release as a base + +### Copying overtop of the base [sandbox gamemode](https://github.com/facepunch/sandbox) + +1. Load in-game or `git clone https://github.com/facepunch/sandbox.git` to `sbox/addons/` +2. Copy this repo on-top diff --git a/unpack-assets.bat b/unpack-assets.bat new file mode 100755 index 0000000..dffb34f --- /dev/null +++ b/unpack-assets.bat @@ -0,0 +1 @@ +xcopy /E models\wirebox\ ..\..\..\models\wirebox\ \ No newline at end of file