docs: update docs

This commit is contained in:
2023-09-30 03:02:09 +03:00
parent 6bfb7536ec
commit 00dba79fd2
5 changed files with 41 additions and 2 deletions

View File

@@ -1,8 +1,43 @@
# mudblock
# Mudblock
This is an MUD ([Multi User Dungeon](https://en.wikipedia.org/wiki/Multi-user_dungeon)) client,
This is a MUD ([Multi User Dungeon](https://en.wikipedia.org/wiki/Multi-user_dungeon)) client,
designed to be cross platform for both mobile and desktop.
Mudblock supports scripting via Lua, with portable files, which you can tie all together using
aliases, triggers and other familiar MUD client features.
![android screenshot 1](/assets/images/docs/sc001.png)
![android screenshot 2](/assets/images/docs/sc002.png)
![android screenshot 3](/assets/images/docs/sc003.png)
## Features
- Multiple profiles
- Triggers
- Aliases
- Supports scripting (Lua) that aims to be compatible with MUSHclient
- Profiles are portable & sharing content is easy
### Planned features
- Customizable on-screen buttons
- Background app keepalive
- Timers
- MUSHclient plugin compatibility
### Supported platforms
Tested:
- Android
- macOS
Not tested:
- Windows
- Linux
- iOS
## Development
1. Install [Flutter](https://docs.flutter.dev/get-started/install)

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

4
lib/core/settings.dart Normal file
View File

@@ -0,0 +1,4 @@
class Settings {
String commandSeparator = ';';
bool echoCommands = true;
}