1 line
14 KiB
JSON
1 line
14 KiB
JSON
|
[{"id":0,"href":"/worldwideportal/docs/getting-started/","title":"Getting Started","section":"Docs","content":" Getting started with Worldwideportal # To access Worldwideportal (WWP), you need to connect to an instance of it. As Free / Open Source software, the administrator of your favourite MUD might have made an instance of WWP available for playing their MUD. If not, you can ask the MUD administrators to install it for you, or install Worldwideportal yourself. This guide will assume you already have access to a working copy.\nNote that if you are using a version provided by your MUD administrator, it might be configured to use a special layout and settings on startup - but the principles are the same.\nUsing the terminal # You interact with WWP primarily by entering commands at the terminal - either for WWP, or for the MUD. Most commands for WWP start with a # symbol, while, unless you (or the administrator of the instance you are using) configure it otherwise with aliases or Lua scripting, anything else is sent to the MUD server.\nConnecting to the server # If you are using a WWP provided by your MUD\u0026rsquo;s administrators, it might be configured to connect on load. If not, or if you want to connect to another MUD, this section can help.\nUse the #connect_mud command to connect to a MUD. Follow it with two parameters: a name of the MUD connection, so you can reference the connection later, and a URL for the WebSocket server for the MUD.\nNote: Due to browser security restrictions, it is not possible for your browser to connect directly to a MUD server\u0026rsquo;s telnet port. Instead, Worldwideportal uses a protocol called \u0026ldquo;WebSockets\u0026rdquo; for browser-MUD connections, and provides a separate component MUD administrators or interested users can run to bridge from WebSocket to telnet. You will need the WebSocket URL. WebSocket URLs start with wss://, e.g. they might look like wss://example.com/ws. If you wanted to create a MUD connection named ex to that URL, you\u0026rsquo;d type #connect_mud ex wss://example.com/ws at the prompt.\nSending commands directly to the MUD # To send a command to the MUD, just type it into the terminal and press enter. You\u0026rsquo;ll see the response on your screen.\nFor example, you might type in your username and password for a MUD (each followed by enter), and\nSending multiple commands # You can type in several commands and have them all be sent in quick succession by separating them with ;. For example, you might type n;e to go north and then east (assuming the MUD you are connected to accepts n and e as direction commands). Neither command will be sent until you press enter.\nSending repeats of the same command # If you want to repeat a command, use # followed by a number, then a space, and then your command. The command will be sent that number of times.\nFor example #5 n might be used to go north 5 places. You can combine it with ;, e.g. #5 n;#3 e to send:\nn n n n n e e e to the MUD server.\nReplaying commands # Use the up arrow to see and re-play the last command you typed. Use the up and down arrows repeatedly to navigate through the history.\nHistory is saved in your browser (last 1000 lines entered only), so it will persist even if you close the browser tab and come back later (unless you access Worldwideportal in Private Browsing / Incognito Mode, in which case it will be lost when you exit out of that mode).\nCopying and pasting # You can copy from the terminal - Ctrl Insert works best for copying, while Shift Insert works best for pasting. Some other common keypresses don\u0026rsquo;t work in all browsers.\nSetting aliases # If you often send the same command, you can set an alias - meaning that anytime you type a certain thing, instead of sending it to the MUD, it is replaced by another command (which could use ; to actually execute several commands).\nYou set an alias with #alias what-to-match commands-to-run.\nThe what-to-match is interpreted as a regular expression (regex), meaning a description of text to match that also uses special symbols
|