Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nebual committed Jun 13, 2021
1 parent 0eb8516 commit 9e2479a
Showing 1 changed file with 32 additions and 9 deletions.
41 changes: 32 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,50 @@

## 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
Very early WIP (as is S&box itself).

- Wiring Tool is equivalent to G-Wiremod's non-Adv version, with basic Debugger and Gate spawning functionalities too
- Outputs: Buttons and a Wire Keyboard (effectively a Pod Controller with a builtin vehicle)
- Inputs: Thrusters, Lights
- Gates: the basic arithmetic/logic

## 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:
however [[A]lex is working on a modular Gamemode framework](https://github.com/Ceveos/minimal-extended) which might work for us.
Unfortunately, the base 'Sandbox' gamemode needs to be modified to be more extendable, so grabbing the latest Github Release with those changes already applied is easiest.

### Using the latest Github Release

1. Download it to `steamapps/common/sbox/addons/`
2. `cd wirebox/addons/code/wirebox && git pull`


### Using minimal-extended modular gamemode framework
### Building from scratch

1. Start with `minimal-extended` modular addon framework:
```
cd steamapps/common/sbox/addons
git clone https://github.com/Ceveos/minimal-extended.git
```
2. Clone Wirebox on top:
```
cd minimal-extended/code/addons
git clone https://github.com/wiremod/wirebox.git
cd wirebox
./unpack-assets.bat
./asset-copier.bat
```
3. Apply Nebual's latest Sandbox extensions (todo: track in Git somehow)


Alternatively, use the latest Github Release as a base
## Developing

### Copying overtop of the base [sandbox gamemode](https://github.com/facepunch/sandbox)
Hotreloading is neat, and generally works well - limitations include:
- Base UI, such as the Spawnmenu's tools/spawnlists, don't reload without a map change
- seems a bit less reliable for non-host players, though often works
- some Model properties don't reload, such as Prop breakability
- You'll need `./asset-watcher.ps1` running for assets/ui

1. Load in-game or `git clone https://github.com/facepunch/sandbox.git` to `sbox/addons/`
2. Copy this repo on-top
### Assets Watcher
Some files need to be in the "root directory" of the gamemode (eg. `sbox/addons/minimal-extended/models/`).
`./asset-copier.bat` will delete old and copy in new files, or `./asset-watcher.ps1` will actively watch for new changes and copy them in as they occur.

0 comments on commit 9e2479a

Please sign in to comment.