Skip to content

Commit

Permalink
usage manual for 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
BanceDev authored Aug 16, 2024
1 parent 02fcb08 commit b2da4c0
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ The Model Tools pane contains a suite of options to further manipulate the model

### Texture Viewer

<p align="center">
<img src="https://github.com/BanceDev/QuakePrism/blob/main/docs/texview.png" alt="Start Screen"/>
</p>

The texture viewer is a simple pane that can render any image or lump files as well as convert between image and lump with the button toolbar at the top.

### Palette Editor
Expand All @@ -106,13 +110,17 @@ The palette editor is composed of an array of colors that loads in the palette.l

### Sprite Tools

"insert sprite panel image here"
<p align="center">
<img src="https://github.com/BanceDev/QuakePrism/blob/main/docs/sprview.png" alt="Start Screen"/>
</p>

The sprite tools take on a similar design to the model viewer. It also contains a slider for animating sprites as well as utility buttons for saving, loading, and adding/removing frames from a sprite. There is also a handy checkbox that visualizes the bounding radius for the sprite. The right column allows you to modify the other sprite properties that are relevant to how it is used in the Quake engine.

### WAD Tools

"insert wad panel here"
<p align="center">
<img src="https://github.com/BanceDev/QuakePrism/blob/main/docs/wadview.png" alt="Start Screen"/>
</p>

The WAD tools are a very streamlined and minimalistic approach to creating and editing WAD files. It supports both WADs for mapping (miptex WADs) as well as WADs for UI (lump WADs) like the gfx.wad file that ships with the game. The tooling for both of these texture types is exactly the same since all of the mipmapping for the map WADs is done for you by the program.

Expand Down
Binary file modified docs/editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sprview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/texview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wadview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b2da4c0

Please sign in to comment.