Lich:Profanity - Revision history

HORIBU1: /* Logging in */ wrap flags in code block

2026-01-16T17:28:27Z

Logging in: wrap flags in code block

← Older revision		Revision as of 12:28, 16 January 2026
Line 39:		Line 39:

	For other game instances you need to update the CLI flags. Supported options include:		For other game instances you need to update the CLI flags. Supported options include:
	* --gemstone		* <code>--gemstone</code>
	* --shattered		* <code>--shattered</code>
	* --gemstone --shattered		* <code>--gemstone --shattered</code>
	* --gemstone --platinum		* <code>--gemstone --platinum</code>
	* --gemstone --test		* <code>--gemstone --test</code>
	* --dragonrealms		* <code>--dragonrealms</code>
	* --fallen		* <code>--fallen</code>
	* --dragonrealms --fallen		* <code>--dragonrealms --fallen</code>
	* --dragonrealms --platinum		* <code>--dragonrealms --platinum</code>
	* --dragonrealms --test		* <code>--dragonrealms --test</code>

	A default installation will need a template. Two default templates are provided. Make sure to rename your template after your character name ProfanityFE/templates/charname.xml and is not empty. If you do not have a template, it will default to load the default.xml template. You can copy the template tysong.xml file with the character name you are logging in as:		A default installation will need a template. Two default templates are provided. Make sure to rename your template after your character name ProfanityFE/templates/charname.xml and is not empty. If you do not have a template, it will default to load the default.xml template. You can copy the template tysong.xml file with the character name you are logging in as:

HORIBU1: /* Logging in */ add additional game instance flag docs

2026-01-16T17:27:34Z

Logging in: add additional game instance flag docs

@@ Line 37: / Line 37: @@
 ruby ~/lich5/lich.rbw --login Rinualdo --without-frontend --detachable-client=8000 --gemstone &
 </pre>
 A default installation will need a template. Two default templates are provided. Make sure to rename your template after your character name ProfanityFE/templates/charname.xml and is not empty. If you do not have a template, it will default to load the default.xml template. You can copy the template tysong.xml file with the character name you are logging in as:

HORIBU1: /* Logging in */ add --gemstone flag

2026-01-14T01:41:59Z

Logging in: add --gemstone flag

← Older revision		Revision as of 20:41, 13 January 2026
Line 35:		Line 35:
	To log in the character Rinualdo, one would firstly issue a command like:		To log in the character Rinualdo, one would firstly issue a command like:
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
	ruby ~/lich5/lich.rbw --login Rinualdo --without-frontend --detachable-client=8000 &		ruby ~/lich5/lich.rbw --login Rinualdo --without-frontend --detachable-client=8000 --gemstone &
	</pre>		</pre>

Line 70:		Line 70:
	echo "Logging in $character in detached mode."		echo "Logging in $character in detached mode."
	echo "call profanity in another terminal"		echo "call profanity in another terminal"
	ruby $HOME/lich5/lich.rbw --login $character --without-frontend --detachable-client=8000		ruby $HOME/lich5/lich.rbw --login $character --without-frontend --detachable-client=8000 --gemstone
	</pre>		</pre>

SDANIEL: /* The power of scripting */ commas are not good for bash arrays

2025-01-13T23:01:20Z

The power of scripting: commas are not good for bash arrays

← Older revision		Revision as of 18:01, 13 January 2025
Line 345:		Line 345:
	LICH_BIN=/home/servermc/lich5/lich.rbw		LICH_BIN=/home/servermc/lich5/lich.rbw
	RUBY_BIN=/home/servermc/.rbenv/versions/3.3.3/bin/ruby		RUBY_BIN=/home/servermc/.rbenv/versions/3.3.3/bin/ruby
	CHAR_LIST=("Character1", "Character2", "Character3")		CHAR_LIST=("Character1" "Character2" "Character3")

	echo ""		echo ""

HORIBU1: update references to Lich5 and ProfanityFE

2024-06-20T13:52:58Z

update references to Lich5 and ProfanityFE

← Older revision		Revision as of 08:52, 20 June 2024
Line 26:		Line 26:
	*'''Because Profanity cannot login to GemStone, one must login via Lich's Game Entry and ''save'' the information.'''		*'''Because Profanity cannot login to GemStone, one must login via Lich's Game Entry and ''save'' the information.'''
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
	ruby ~/~~lich-5~~/lich.rbw		ruby ~/lich5/lich.rbw
	</pre>		</pre>
	A graphical interface will pop up (shown on the right), and one should navigate to the Game Entry tab at the top, enter their Simutronics user name and password, and hit 'Connect'. Assuming the user name and password are correct, the list will then be populated with the player's characters to choose from. ''The most important step is to check the box 'Save this info for quick game entry'''. It doesn't matter what is done with the radio buttons for Wizard / Stormfront (we won't be using either one) nor the 'Custom launch command'. The present step is only done once, simply to tell Lich (and thus Profanity) how to login a character, not to actually perform said login. As the Wizard radio button is selected by default, it is assumed the user simply leaves it as it is. Once these things are done, simply hit 'Play' and the pop-up will close, saving your login details.		A graphical interface will pop up (shown on the right), and one should navigate to the Game Entry tab at the top, enter their Simutronics user name and password, and hit 'Connect'. Assuming the user name and password are correct, the list will then be populated with the player's characters to choose from. ''The most important step is to check the box 'Save this info for quick game entry'''. It doesn't matter what is done with the radio buttons for Wizard / Stormfront (we won't be using either one) nor the 'Custom launch command'. The present step is only done once, simply to tell Lich (and thus Profanity) how to login a character, not to actually perform said login. As the Wizard radio button is selected by default, it is assumed the user simply leaves it as it is. Once these things are done, simply hit 'Play' and the pop-up will close, saving your login details.
Line 35:		Line 35:
	To log in the character Rinualdo, one would firstly issue a command like:		To log in the character Rinualdo, one would firstly issue a command like:
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
	ruby ~/~~lich-5~~/lich.rbw --login Rinualdo --without-frontend --detachable-client=8000 &		ruby ~/lich5/lich.rbw --login Rinualdo --without-frontend --detachable-client=8000 &
	</pre>		</pre>

Line 70:		Line 70:
	echo "Logging in $character in detached mode."		echo "Logging in $character in detached mode."
	echo "call profanity in another terminal"		echo "call profanity in another terminal"
	ruby $HOME/~~lich-5~~/lich.rbw --login $character --without-frontend --detachable-client=8000		ruby $HOME/lich5/lich.rbw --login $character --without-frontend --detachable-client=8000
	</pre>		</pre>

Line 343:		Line 343:

	port=8000		port=8000
	LICH_BIN=/home/servermc/~~lich-gs~~/lich.rbw		LICH_BIN=/home/servermc/lich5/lich.rbw
	RUBY_BIN=/home/servermc/.rbenv/versions/3.2.2/bin/ruby		RUBY_BIN=/home/servermc/.rbenv/versions/3.3.3/bin/ruby
	CHAR_LIST=("Character1", "Character2", "Character3")		CHAR_LIST=("Character1", "Character2", "Character3")

Line 383:		Line 383:
	2. Grab lich and unzip it		2. Grab lich and unzip it
	<pre{{log2}}>		<pre{{log2}}>
	wget https://~~lichproject~~.~~org~~/download/lich-~~4.6.44~~.zip		wget https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip
	unzip lich-~~4.6.44~~.zip		unzip lich-5.zip
	</pre>		</pre>

Line 390:		Line 390:
	<pre{{log2}}>		<pre{{log2}}>
	cd ~/		cd ~/
	git clone https://github.com/~~matt~~-~~lowe~~/ProfanityFE.git		git clone https://github.com/elanthia-online/ProfanityFE.git
	cp ~/ProfanityFE/profanity.rb ~/lich		cp ~/ProfanityFE/profanity.rb ~/lich
	</pre>		</pre>
Line 400:		Line 400:
	6. Lastly, you can run lich and profanity as shown above now that you have a character profile saved in the data folder.		6. Lastly, you can run lich and profanity as shown above now that you have a character profile saved in the data folder.
	<pre{{log2}}>		<pre{{log2}}>
	ruby ~/~~lich~~/lich.rb --login <character> --without-frontend --detachable-client=8000 2> /dev/null &		ruby ~/lich5/lich.rb --login <character> --without-frontend --detachable-client=8000 2> /dev/null &
	ruby ~/profanity.rb --port=8000		ruby ~/profanity.rb --port=8000
	</pre>		</pre>

HORIBU1: /* Logging in */ updated for newer supported templates folder

2024-02-29T02:37:19Z

Logging in: updated for newer supported templates folder

← Older revision		Revision as of 21:37, 28 February 2024
Line 38:		Line 38:
	</pre>		</pre>

	A default installation will need a template. Two default templates are provided. Make sure your ~/~~.profanity~~/charname.xml ~~file exists~~ and is not empty. You can copy the template tysong.xml file ~~into your ~/.profanity directory~~ with the character name you are logging in as:		A default installation will need a template. Two default templates are provided. Make sure to rename your template after your character name ProfanityFE/templates/charname.xml and is not empty. If you do not have a template, it will default to load the default.xml template. You can copy the template tysong.xml file with the character name you are logging in as:
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
		⚫	cp ~/ProfanityFE/templates/tysong.xml ~/ProfanityFE/templates/rinualdo.xml
	mkdir ~/.profanity
⚫	cp ~/ProfanityFE/templates/tysong.xml ~/~~.profanity~~/rinualdo.xml
	</pre>		</pre>
	After which, one can now launch Profanity to connect to the previously previously ran Lich login:		After which, one can now launch Profanity to connect to the previously previously ran Lich login:

IPITTMAN: Ditto

2024-01-12T00:47:33Z

Ditto

← Older revision		Revision as of 19:47, 11 January 2024
Line 66:		Line 66:

	if [ -z "$character" ];then		if [ -z "$character" ];then
			echo "Usage: $0 character_name"
	exit		exit
	fi		fi

IPITTMAN: Cleanup and update the gsiv.sh and profanity.sh script examples

2024-01-12T00:46:18Z

Cleanup and update the gsiv.sh and profanity.sh script examples

← Older revision		Revision as of 19:46, 11 January 2024
Line 59:		Line 59:
	To perform the game login, one might create a script called ''gsiv.sh'' as follows:		To perform the game login, one might create a script called ''gsiv.sh'' as follows:
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
	#!/bin/bash		#!/usr/bin/env bash
	# Script to automate login to Tillmen's lich in detached mode		# Script to automate login to Tillmen's lich in detached mode
	# Author: daid		# Author: daid

	character="$1"		character="$1"
Line 70:		Line 70:
	echo "Logging in $character in detached mode."		echo "Logging in $character in detached mode."
	echo "call profanity in another terminal"		echo "call profanity in another terminal"
	ruby $HOME/lich/lich.rb --login $character --without-frontend --detachable-client=8000		ruby $HOME/lich-5/lich.rbw --login $character --without-frontend --detachable-client=8000
	</pre>		</pre>

	To launch Profanity repeatedly until a connection is established, one can create a script called ''profanity.sh'':		To launch Profanity repeatedly until a connection is established, one can create a script called ''profanity.sh'':
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
	#!/bin/bash		#!/usr/bin/env bash
	# Profanity login wrapper		# Profanity login wrapper
	# Author: daid		# Author: daid

			character="$1"

			if [ -z "$character" ];then
			echo "Usage: $0 character_name"
			exit
			fi

	$(exit 1)		$(exit 1)
	until $HOME/~~lich~~/profanity.rb --port=8000 2> /dev/null ;do		until ruby $HOME/ProfanityFE/profanity.rb --port=8000 --char=$character 2> /dev/null ;do
	printf "."		printf "."
	sleep 1		sleep 1

HORIBU1: /* Logging in */ make the .profanity directory

2023-11-28T15:59:54Z

Logging in: make the .profanity directory

← Older revision		Revision as of 10:59, 28 November 2023
Line 40:		Line 40:
	A default installation will need a template. Two default templates are provided. Make sure your ~/.profanity/charname.xml file exists and is not empty. You can copy the template tysong.xml file into your ~/.profanity directory with the character name you are logging in as:		A default installation will need a template. Two default templates are provided. Make sure your ~/.profanity/charname.xml file exists and is not empty. You can copy the template tysong.xml file into your ~/.profanity directory with the character name you are logging in as:
	<pre{{log2\|margin-right=35%}}>		<pre{{log2\|margin-right=35%}}>
			mkdir ~/.profanity
	cp ~/ProfanityFE/templates/tysong.xml ~/.profanity/rinualdo.xml		cp ~/ProfanityFE/templates/tysong.xml ~/.profanity/rinualdo.xml
	</pre>		</pre>

HORIBU1: /* The power of scripting */ update login rewards script section

2023-11-27T19:00:29Z

The power of scripting: update login rewards script section

@@ Line 317: / Line 317: @@
 ==The power of scripting==
-Here we show a simple example to showcase the power of using Lich in detached mode.  Although this example does not strictly use Profanity, it offers an idea of the flexibility and simplicity of the approach.  With the advent of [[Login Rewards]], one likely wishes to log in all their characters each day, yet this is a tedious process.  It can be easily scripted.
+Here we show a simple example to showcase the power of using Lich in detached mode. With the advent of [[Login Rewards]], one likely wishes to log in all their characters each day, yet this is a tedious process.  It can be easily scripted.
-Create an executable in your PATH, for example ''gsiv-login.sh'' and simply fill the array CHARNAME with all the characters you want to log in.
+Create a lich script in your scripts folder called ''quit.lic'' and fill it with something simple like:
 <pre{{log2|margin-right=35%}}>
 #!/bin/bash
-    RETRY=0
+    fi
 done
 </pre>
 {{top}}