Difference between revisions of "BeipMU"

From Flexible Survival
Jump to: navigation, search
(Created page)
 
(Special features)
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
BeipMU is a MUCK client available from https://beipdev.github.io/BeipMU/ for Windows systems, although most features also runs very well under [https://www.winehq.org/ wine] on linux and MacOS. There is also a [https://discord.gg/3A5quTU discord server] available for assistance in using it.
+
BeipMU is a MUCK client available from https://beipdev.github.io/BeipMU/ for Windows systems, although most features also runs very well under [https://www.winehq.org/ Wine] on Linux and MacOS. There is also a [https://discord.gg/3A5quTU Discord server] available for assistance in using it.
  
 
== Useful features ==
 
== Useful features ==
Line 7: Line 7:
 
* Scriptable
 
* Scriptable
 
* Designed for ease of use
 
* Designed for ease of use
 +
* Experimental Pueblo support
 
* Supports stat panes from Flexible Survival with zero setup!
 
* Supports stat panes from Flexible Survival with zero setup!
 
  
 
== Quickstart ==
 
== Quickstart ==
  
* In the connection window, add a new server and fill in <code>flexiblesurvival.com:2222</code> as the port. (Other ports listed on the [[Main Page|main page]] will work too, but lack SSL/TLS support).
+
* In the connection window, add a new server and fill in <code>flexiblesurvival.com:2002</code> as the port. (Other ports listed on the [[Main Page|main page]] will work too, but lack SSL/TLS support.)
* Create a new character under that server and fill in <code>connect &lt;name&gt; &lt;password&gt;</code> as the connect string to automatically log you in as that character.
+
* Create a new character under that server. Enter your password in the relevant field, and then enter the following connect string- <code>connect &lt;name&gt; %PASSWORD%</code>, <code>&lt;name&gt;</code> is your character's name. <code>%PASSWORD%</code> is auto-filled by BeipMU using the password you entered above.
 
* Click 'Connect'
 
* Click 'Connect'
 
[[File:Beip_server_connect.png|200px]] [[File:Beip_character_setup.png|200px]]
 
[[File:Beip_server_connect.png|200px]] [[File:Beip_character_setup.png|200px]]
 
  
 
== Special features ==
 
== Special features ==
Line 25: Line 24:
 
This utilises the pseudo-[[GMCP]] support currently in place as a beta-level feature on Flexible Survival.
 
This utilises the pseudo-[[GMCP]] support currently in place as a beta-level feature on Flexible Survival.
  
 +
BeipMU supports emulating the Pueblo protocol, which FS utilizes for interactive hyperlinks inside of the client. If it's not enabled automatically for you, simply type <code>puebloclient</code> to force enable it.
 +
 +
== Chat separator ==
 +
 +
Save the following to a file and use Options->Triggers->Import, or copy+paste into a new trigger.
 +
 +
<nowiki>
 +
Version=301
 +
Connections
 +
{
 +
  Triggers
 +
  {
 +
    {
 +
      Description="Chat separator"
 +
      Example="[Public] This is a test message "
 +
      OncePerLine=true
 +
      FindString
 +
      {
 +
        MatchText="^\\[(Public|Party|WC|Newbie|LFG|Theme|Market|Badges|Dev|Pickup|RP|Naughty|Judge)\\] (.+)$"
 +
        RegularExpression=true
 +
        MatchCase=true
 +
      }
 +
      Spawn
 +
      {
 +
        Active=true
 +
        Title="\\1"
 +
        TabGroup="Comm channels"
 +
      }
 +
    }
 +
  }
 +
}
 +
</nowiki>
 +
 +
If you want to have pages appear in one of the tabs, save this alongside the above script:
 +
 +
<nowiki>
 +
Version=308
 +
Connections
 +
{
 +
  Triggers
 +
  {
 +
    {
 +
      Description="Page separator"
 +
      Example="Dre'ji pages, \"Indeed!\""
 +
      StopProcessing=true
 +
      OncePerLine=true
 +
      FindString
 +
      {
 +
        MatchText="^(\\S+ page|In a page-pose)"
 +
        RegularExpression=true
 +
        MatchCase=true
 +
      }
 +
      Spawn
 +
      {
 +
        Active=true
 +
        Title="Pages"
 +
        TabGroup="Comm channels"
 +
      }
 +
      Triggers.Active=false
 +
    }
 +
  }
 +
}
 +
</nowiki>
 +
 +
And, for OOC chat:
  
 +
<nowiki>
 +
Version=308
 +
Connections
 +
{
 +
  Triggers
 +
  {
 +
    {
 +
      Description="OOC separator"
 +
      Example="<OOC> Zelmra pouts!"
 +
      StopProcessing=true
 +
      OncePerLine=true
 +
      FindString
 +
      {
 +
        MatchText="^(<OOC>)"
 +
        RegularExpression=true
 +
        MatchCase=true
 +
      }
 +
      Spawn
 +
      {
 +
        Active=true
 +
        Title="OOC"
 +
        TabGroup="Comm channels"
 +
      }
 +
      Triggers.Active=false
 +
    }
 +
  }
 +
}
 +
</nowiki>
  
 
[[Category:UI Guides]]
 
[[Category:UI Guides]]

Revision as of 01:07, 27 June 2023

BeipMU is a MUCK client available from https://beipdev.github.io/BeipMU/ for Windows systems, although most features also runs very well under Wine on Linux and MacOS. There is also a Discord server available for assistance in using it.

Useful features

  • 256-color support
  • SSL/TLS connections
  • Scriptable
  • Designed for ease of use
  • Experimental Pueblo support
  • Supports stat panes from Flexible Survival with zero setup!

Quickstart

  • In the connection window, add a new server and fill in flexiblesurvival.com:2002 as the port. (Other ports listed on the main page will work too, but lack SSL/TLS support.)
  • Create a new character under that server. Enter your password in the relevant field, and then enter the following connect string- connect <name> %PASSWORD%, <name> is your character's name. %PASSWORD% is auto-filled by BeipMU using the password you entered above.
  • Click 'Connect'

200px 200px

Special features

A screenshot of BeipMU's FS stat panels

Fully automated stat panes! Just run the command livestats #on after connecting, and some additional windows should appear showing you various attributes of your character. The information within will also update in (near-)realtime.

This utilises the pseudo-GMCP support currently in place as a beta-level feature on Flexible Survival.

BeipMU supports emulating the Pueblo protocol, which FS utilizes for interactive hyperlinks inside of the client. If it's not enabled automatically for you, simply type puebloclient to force enable it.

Chat separator

Save the following to a file and use Options->Triggers->Import, or copy+paste into a new trigger.

Version=301
Connections
{
  Triggers
  {
    {
      Description="Chat separator"
      Example="[Public] This is a test message	"
      OncePerLine=true
      FindString
      {
        MatchText="^\\[(Public|Party|WC|Newbie|LFG|Theme|Market|Badges|Dev|Pickup|RP|Naughty|Judge)\\] (.+)$"
        RegularExpression=true
        MatchCase=true
      }
      Spawn
      {
        Active=true
        Title="\\1"
        TabGroup="Comm channels"
      }
    }
  }
}

If you want to have pages appear in one of the tabs, save this alongside the above script:

Version=308
Connections
{
  Triggers
  {
    {
      Description="Page separator"
      Example="Dre'ji pages, \"Indeed!\""
      StopProcessing=true
      OncePerLine=true
      FindString
      {
        MatchText="^(\\S+ page|In a page-pose)"
        RegularExpression=true
        MatchCase=true
      }
      Spawn
      {
        Active=true
        Title="Pages"
        TabGroup="Comm channels"
      }
      Triggers.Active=false
    }
  }
}
 

And, for OOC chat:

Version=308
Connections
{
  Triggers
  {
    {
      Description="OOC separator"
      Example="<OOC> Zelmra pouts!"
      StopProcessing=true
      OncePerLine=true
      FindString
      {
        MatchText="^(<OOC>)"
        RegularExpression=true
        MatchCase=true
      }
      Spawn
      {
        Active=true
        Title="OOC"
        TabGroup="Comm channels"
      }
      Triggers.Active=false
    }
  }
}