mirror of
https://github.com/chenasraf/mudblock.git
synced 2026-05-18 01:48:57 +00:00
docs: update docs
This commit is contained in:
39
README.md
39
README.md
@@ -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.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## 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)
|
||||
|
||||
BIN
assets/images/docs/sc001.png
Normal file
BIN
assets/images/docs/sc001.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 169 KiB |
BIN
assets/images/docs/sc002.png
Normal file
BIN
assets/images/docs/sc002.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 151 KiB |
BIN
assets/images/docs/sc003.png
Normal file
BIN
assets/images/docs/sc003.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
4
lib/core/settings.dart
Normal file
4
lib/core/settings.dart
Normal file
@@ -0,0 +1,4 @@
|
||||
class Settings {
|
||||
String commandSeparator = ';';
|
||||
bool echoCommands = true;
|
||||
}
|
||||
Reference in New Issue
Block a user