docs, password config, help, about

render -> draw, file explorer, writer is RefCell
This commit is contained in:
stjet
2025-01-01 09:38:11 +00:00
parent acdb59d668
commit 03f1d649e0
34 changed files with 542 additions and 152 deletions

View File

@@ -0,0 +1,21 @@
Displays desktop backgrounds, which can be a BMP image file or a solid colour.
## Config
Config files should have the appropriated protections so they can only be written to root privileges.
In `$XDG_CONFIG_DIR/ming-wm/desktop-background`, you can configure what the desktop background should be for each workspace. The first line decides the background for the first workspace, and so on. If lines are missing, or empty, or the config file is missing, the default green background is used.
If a line starts with "#", and is followed by 6 lowercase hex characters, then it will interpreted as a RGB colour.
If a line starts with "r", then what follows with be interpreted as a path to a BMP image file in BGRA order, and if it starts with any other character, what follows will be interpreted as a path to a BMP image file in RGBA order.
Example:
```
#008080
#003153
r./bmps/castle1440x842.bmp
r./bmps/ming1440x842.bmp
r./bmps/blur1440x842.bmp
```

View File

@@ -0,0 +1,5 @@
Shown when screen is locked. Unlocks the screen when correct password is entered.
## Config
Before building, create a `password.txt` in the same directory as the `build.rs` file with the password.

View File

@@ -0,0 +1,13 @@
The goal of the game is to reveal all tiles that are not mines. Revealing a tile that is a mine means game over.
The game consists of revealing tiles. If a revealed tile has no mines directly adjacent to it (above, below, left, right, top left, top right, etc). All tiles adjacent to it are revealed. If any of the newly revealed tiles have no mines directly adjacent to it, then... well you get the point.
Tiles with mines adjacent to it are labeled with a number stating how many mines are adjacent to it.
To start the game, first enter in a seed for the game, by typing in four random characters, then hitting enter. Then, choose the first tile to reveal. That first tile is guaranteed to be a non-mine tile with no mines adjacent to it.
Games with the same seed and first tile revealed will have the same mine layout, making the game suitable for competition.
Choosing to reveal a tile is simple. Just type in the two character name of that tile. For example, 'c4' or '15'. If you make a mistake with the first character, just use the backspace/delete key to clear.
Upon winning or losing, press a key to play again.