Skip to content

Commit 8ed7284

Browse files
committed
Update Readme
1 parent 9ba427d commit 8ed7284

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,14 @@ NOTE: You need BOTH setup.exe and PhantomBotServiceSetup.msi to perform the inst
77

88
To use the service:
99

10-
Install PhantomBotService wherever you like using setup.exe, it may be easiest to set the install location to the same folder as PhantomBot. NOTE: If setup.exe successfully installs .NET Framework 4.7.2, it will automatically run PhantomBotServiceSetup.msi for you
11-
In the folder where you installed PhantomBotService, edit PhantomBotService.config in a text editor, such as Notepad or Notepad++, and ensure that the path on Line 2 is set to the same folder as your PhantomBot.jar file. Optionally enable logging.
12-
Start the service from Microsoft Management Console. The easiest way to get there is to right-click the Start button, click Computer Management and then go to Computer Management > Services and Applications > Services on the left pane
10+
Install PhantomBotService wherever you like using setup.exe, it may be easiest to set the install location to the same
11+
folder as PhantomBot. NOTE: If setup.exe successfully installs .NET Framework 4.7.2, it will automatically run
12+
PhantomBotServiceSetup.msi for you
13+
In the folder where you installed PhantomBotService, edit PhantomBotService.config in a text editor, such as Notepad or
14+
Notepad++, and ensure that the path on the line underneath [Bot Install Directory] is set to the same folder as your
15+
PhantomBot.jar file. Optionally set some of the other directives, listed at the bottom of the release notes
16+
Start the service from Microsoft Management Console. The easiest way to get there is to right-click the Start button,
17+
click Computer Management and then go to Computer Management > Services and Applications > Services on the left pane
1318

1419
The logging feature will save a log file in the same folder as PhantomBot.jar containing the output of the bot console. The file name will be unique each time the server starts the bot
1520

@@ -19,13 +24,18 @@ If the service encounters an Exception at the service level while attempting to
1924

2025
If setup.exe fails to install .NET Framework 4.7.2, follow these steps
2126

22-
Download the offline installer for .NET Framework 4.7.2 from https://support.microsoft.com/en-us/help/4054530/microsoft-net-framework-4-7-2-offline-installer-for-windows
27+
Download the offline installer for .NET Framework 4.7.2
28+
https://support.microsoft.com/en-us/help/4054530/microsoft-net-framework-4-7-2-offline-installer-for-windows
2329
Install .NET Framework 4.7.2 from the offline installer
2430
Run PhantomBotServiceSetup.msi to install the service
2531

2632
Available options in PhantomBotService.config:
2733

28-
\[Bot Install Directory] - _(Required)_ The line under this directive must be the full path to the bot installation directory (where PhantomBot.jar is located)
29-
\[Logging Enabled] - _(Optional, Defaults to false)_ The line under this directive can be changed to read ***true*** to enable a log of the bot console output to be created in the bot installation directory
30-
\[Launch Command] - _(Optional, Defaults to the java included with the bot)_ The line under this directive can be used to override the command used to launch the bot
31-
\[Launch Arguments] - _(Optional, Defaults to the arguments used by launch.bat)_ The line under this directive can be used to override the command line arguments provided to the launch command
34+
[Bot Install Directory] - (Required) The line under this directive must be the full path to the bot installation directory
35+
(where PhantomBot.jar is located)
36+
[Logging Enabled] - (Optional, Defaults to false) The line under this directive can be changed to "true" (without quotes)
37+
to enable a log of the bot console output to be created in the bot installation directory
38+
[Launch Command] - (Optional, Defaults to the java included with the bot) The line under this directive can be used to
39+
override the command used to launch the bot
40+
[Launch Arguments] - (Optional, Defaults to the arguments used by launch.bat) The line under this directive can be used
41+
to override the command line arguments provided to the launch command

0 commit comments

Comments
 (0)