Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wootguy authored Jul 26, 2020
1 parent c1a0298 commit 4536d7d
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,41 @@
A tool for modifying and merging Sven Co-op maps without decompiling.

# Usage
To launch the 3D editor, drag and drop a .bsp file onto the executable, or "Open with" bspguy, or run `bspguy <mapname>`

See the [wiki](https://github.com/wootguy/bspguy/wiki) for tutorials.

## Editor Features
- Keyvalue editor with FGD support
- Entity + BSP model creation and duplication
- Easy object movement and scaling
- Vertex manipulation + face splitting
- Used to make perfectly shaped triggers. A box is often good enough, though.
- BSP model origin movement/alignment
- Optimize + clean commands to prevent overflows
- Hull deletion + redirection + creation
- clipnode generation is similar to `-cliptype legacy` in the CSG compiler (the _worst_ method)
- Basic face editing

![image](https://user-images.githubusercontent.com/12087544/88471604-1768ac80-cec0-11ea-9ce5-13095e843ce7.png)

**The editor is full of bugs, unstable, and has no undo button yet. Save early and often! Make backups before experimenting with anything.**

Requires OpenGL 3.0 or later.

## First-time Setup
1. Click `File` -> `Settings` -> `General`
1. Set the `Game Directory` to your `Sven Co-op` folder path, then click `Apply Changes`.
- This will fix the missing textures.
1. Click the `FGDs` tab and add the full path to your sven-coop.fgd (found in `Sven Co-op/svencoop/`). Click `Apply Changes`.
- This will give point entities more colorful cubes, and enable the `Attributes` tab in the `Keyvalue editor`.

bspguy saves configuration files to `%APPDATA%/bspguy` on Windows.


## Command Line
Some functions are only available via the CLI.

```
Usage: bspguy <command> <mapname> [options]
Expand All @@ -16,10 +51,6 @@ Usage: bspguy <command> <mapname> [options]
Run 'bspguy <command> help' to read about a specific command.
```

To launch the 3D editor, drag and drop a .bsp file onto the executable, or "Open with" bspguy, or run `bspguy <mapname>`

See the [wiki](https://github.com/wootguy/bspguy/wiki) for more info.

# Building the source
### Windows users:
1. Install CMake and Visual Studio
Expand Down

0 comments on commit 4536d7d

Please sign in to comment.