Skip to content

Commit

Permalink
doc: Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
buchholzs committed Dec 24, 2024
1 parent b2f108e commit a7a829b
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ A material editor which allows interactive manipulating materials of objects in
Both programs use the [3D plush library](/plush/pl_api.html) which was formerly located [here](http://www.nullsoft.com/free/plush/). For the GUI, I used the [Depui](/depui/homepage/depui.htm) library. The graphics library is [GRX](/contrib/grx248/doc/grx248um.html).

# History
I started working on this project in 2002, so the graphics are outdated by today's standards. The original target platform was DJGPP DOS. Later I switched to Windows as main target platform. Linux is still under construction. In the meantime, I haven't worked on the project for a long time. Anyway, I want to finally finish the project, achieve the goals of the time and practice C++ by the way.
I started working on this project in 2002, so the graphics might be outdated by today's standards. The original target platform was DJGPP DOS. Later I switched to Windows as main target platform. Linux versions are also available. In the meantime, I haven't worked on the project for a long time. Anyway, I have now finally finished the project, achieved the goals of the time and practiced C++ by the way.


# Usage
These two programs run under Windows.
These two programs run under Windows and Linux.
To start, use

- `PlushPlayer.exe` or
- `Matedit2.exe`
- `PlushPlayer.exe` / `PlushPlayer` or
- `MatEdit.exe` / `MatEdit`


## PlushPlayer
Expand All @@ -26,13 +26,20 @@ You can load any *.scx (Scene XML) file from the "scenes" folder.
When you start PlushPlayer, it shows a file open dialog to select a scene file.

In the scene, you can navigate using the mouse and the following keys:
- w - step forward
- a - step left
- s - step backward
- d - step right
- r - reload a previously loaded scene
- F1 - popup the key help window
- F3 - popup the file open dialog.
|Key | Description |
|-----------|-----------------------|
| `<Esc>` | ingame menu |
| w | move forward |
| a | move left |
| s | move backward |
| d | move right |
| r | reload scene |
| q | quit |
| `<space>` | play/pause |
| F1 | Key Help |
| F3 | Load Scene File |
| F9 | Set move mode to walk |
| F10 | Set move mode to fly |

## Matedit
![Matedit with standard.scx](/assets/img/1.jpeg)
Expand Down

0 comments on commit a7a829b

Please sign in to comment.