Create README.md
This commit is contained in:
parent
811fd766a9
commit
65c8d69434
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# CollabVMSharp
|
||||
|
||||
CollabVM client library in C#.
|
||||
|
||||
## Usage Example
|
||||
|
||||
```cs
|
||||
using CollabVMSharp;
|
||||
// Instantiate the client
|
||||
var cvm = new CollabVMClient("wss://computernewb.com/collab-vm/vm0", "cvmsharptest", "vm0b0t");
|
||||
// Connect to the VM
|
||||
await cvm.Connect();
|
||||
// Send a chat
|
||||
await cvm.SendChat("What hath god wrought?");
|
||||
// Queue a turn, wait until we get the turn
|
||||
await cvm.GetTurn();
|
||||
// Type a string into the VM
|
||||
await cvm.TypeString("hey sexies");
|
||||
// Login as an admin or mod
|
||||
await cvm.Login("hunter2");
|
||||
// Run a command in the QEMU monitor and get a response
|
||||
await cvm.QEMUMonitor("info block");
|
||||
// Send a message when someone takes a turn
|
||||
cvm.TurnUpdate += async (_, e) => {
|
||||
await cvm.SendChat($"You have the turn, {e.Queue[0].Username}!");
|
||||
};
|
||||
```
|
Loading…
Reference in a new issue