Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
windows_guide [2018/08/09 23:18] sgtbatten [Getting Started with ProfitTrailer on Windows] |
windows_guide [2019/05/06 19:49] (current) armchairguru |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Windows Setup Guide ===== | + | /* |
| + | This is a hidden comment area - don't delete | ||
| + | This page is also a slide - be careful with markup, and test both the page AND the slide when editing | ||
| + | */ | ||
| - | This guide will help you get ProfitTrailer running on Windows. | + | ~~REVEAL~~ |
| - | + | ---->> | |
| - | === Contents === | + | ==== Windows Setup Guide ==== |
| - | + | In slideshow mode, use arrow keys or the navigation buttons at lower right of screen to move forward/back.\\ | |
| - | * [[windows_guide#Installing Java 8]] | + | <---- |
| - | * [[windows_guide#Downloading ProfitTrailer]] | + | ---->> |
| - | * [[windows_guide#Downloading Notepad++]] | + | This guide will help you get ProfitTrailer running on Windows.\\ |
| - | * [[windows_guide#Configuring ProfitTrailer]] | + | If steps are not needed, use the controls or keyboard arrow keys to move forward through the slides. |
| - | * [[Mandatory Settings]] | + | |
| - | * [[windows_guide#Running ProfitTrailer]] | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ---- | + | |
| + | * Installing Java 8 | ||
| + | * Downloading ProfitTrailer | ||
| + | * Downloading Notepad++ | ||
| + | * Configuring ProfitTrailer | ||
| + | * Mandatory Settings | ||
| + | * Running ProfitTrailer | ||
| + | <---- | ||
| + | ---->> | ||
| ====Getting Started with ProfitTrailer on Windows==== | ====Getting Started with ProfitTrailer on Windows==== | ||
| - | + | First of all, note that running the bot 24/7 is not possible if you allow your PC to fall asleep or close a laptop as the bot will not run anymore.\\ | |
| - | First of all, note that running the bot 24/7 is not possible if you allow your PC to fall asleep or close a laptop as the bot will not run anymore. You may want to consider using a [[VPS]] before installing it on a dedicated computer. | + | You may want to consider using a VPS before installing it on a dedicated computer. |
| - | ---- | + | <---- |
| - | + | ---->> | |
| - | ===1. Installing Java 8 === | + | ====Installing Java 8==== |
| - | + | Download and install Java 8: | |
| - | Download and install Java 8: \\ | + | |
| https://java.com/en/download/ should automatically detect the latest version for your operating system. | https://java.com/en/download/ should automatically detect the latest version for your operating system. | ||
| Alternatively you can select from http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html | Alternatively you can select from http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html | ||
| - | ---- | + | <---- |
| - | + | ---->> | |
| - | ===2. Downloading ProfitTrailer=== | + | ====2. Downloading ProfitTrailer==== |
| - | Go to this link: https://github.com/taniman/profit-trailer/releases.\\ | + | Go to this link: https://github.com/taniman/profit-trailer/releases.\\ |
| - | Download the latest release. \\ | + | Download the latest release.\\ |
| Right click on the zip and select Extract All. | Right click on the zip and select Extract All. | ||
| {{::unzip.png?nolink|}} | {{::unzip.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| Choose a location to extract to, for example on the desktop. | Choose a location to extract to, for example on the desktop. | ||
| {{::windows_unzip_to_desktop.png?nolink|}} | {{::windows_unzip_to_desktop.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| Double click the ProfitTrailer Folder to open it. Note how the folder icon looks different once it is extracted correctly. | Double click the ProfitTrailer Folder to open it. Note how the folder icon looks different once it is extracted correctly. | ||
| {{::profittrailer_folder.png?nolink|}} | {{::profittrailer_folder.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| You may find it helpful to show windows file extensions. | You may find it helpful to show windows file extensions. | ||
| {{::unhide_windows_file_extentions.png?nolink|}} | {{::unhide_windows_file_extentions.png?nolink|}} | ||
| - | ---- | + | <---- |
| + | ---->> | ||
| + | ====3. Downloading Notepad++==== | ||
| - | ===3. Downloading Notepad++=== | + | Now that our files are downloaded and extracted we need to know how to open them.\\ |
| - | + | We need to download and install [[https://notepad-plus-plus.org/download/|Notepad++]].\\ | |
| - | Now that our files are downloaded and extracted we need to know how to open them. We need to download and install [[https://notepad-plus-plus.org/download/|Notepad++]] (NOT Word, wordpad, notepad etc - these will insert incorrect characters in your file). | + | (NOT Word, wordpad, notepad etc - these will insert incorrect characters in your file). |
| Just choose all the default options when installing. | Just choose all the default options when installing. | ||
| + | <---- | ||
| + | ---->> | ||
| + | ====4. Configuring ProfitTrailer==== | ||
| - | + | Most users should only ever need to open the properties files. To do so for the first time right click on application.properties and open with Notepad++.\\ | |
| - | ---- | + | |
| - | === 4. Configuring ProfitTrailer === | + | |
| - | + | ||
| - | + | ||
| - | Most users should only ever need to open the properties files. To do so for the first time right click on application.properties and open with Notepad++. | + | |
| {{::edit_with_notepad_plus_plus.png?nolink|}} | {{::edit_with_notepad_plus_plus.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| If this is not an option (or to permanently make this file open in notepad++) select Open With and choose another App. | If this is not an option (or to permanently make this file open in notepad++) select Open With and choose another App. | ||
| {{::choose_another_app.png?nolink|}} | {{::choose_another_app.png?nolink|}} | ||
| - | + | <---- | |
| - | Select More Apps and also tick ''Always use this app to open .properties files''. | + | ---->> |
| + | Select More Apps and also tick 'Always use this app to open .properties files'. | ||
| {{::windows_more_apps.png?nolink|}} | {{::windows_more_apps.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| Select Look for another App. | Select Look for another App. | ||
| {{::windows_look_for_another_app.png?nolink|}} | {{::windows_look_for_another_app.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| This will bring up a file explorer window. You need to navigate to your installation location for Notepad++. | This will bring up a file explorer window. You need to navigate to your installation location for Notepad++. | ||
| Line 83: | Line 93: | ||
| From now on the properties files should have the green notepad++ icon and can be opened by a simple double click. | From now on the properties files should have the green notepad++ icon and can be opened by a simple double click. | ||
| + | <---- | ||
| + | ---->> | ||
| + | ====5. Mandatory Settings==== | ||
| - | ---- | + | Now we can proceed to setup the [[https://wiki.profittrailer.com/doku.php?id=mandatory_settings|Mandatory Settings]] before attempting to run the bot.\\ |
| - | === 5. Mandatory Settings === | + | * This guide includes configuring your application properties, please check the other configuration pages of the wiki before you go ahead and run the bot on random settings, without knowing what they do. |
| - | + | <---- | |
| - | Now we can proceed to setup the [[mandatory_settings|Mandatory Settings]] before attempting to run the bot. | + | ---->> |
| - | * This guide doesn’t include configuring your settings, so please check the other parts of the wiki for that, before you go ahead and run the bot on random settings, without knowing what they do. | + | {{ app-properties.mp4?640x480&app-prop-preview.png |Application Properties Video Guide}} |
| - | + | <---- | |
| - | ---- | + | ---->> |
| - | ===6. Running ProfitTrailer=== | + | ====6. Running ProfitTrailer==== |
| Double click the Run-ProfitTrailer.cmd file which will launch the bot. | Double click the Run-ProfitTrailer.cmd file which will launch the bot. | ||
| - | The cmd file executes the following command: | + | The CMD file executes the following command: |
| - | java -Djava.net.preferIPv4Stack=true -Dsun.stdout.encoding=UTF-8 -jar ProfitTrailer.jar -XX:+UseConcMarkSweepGC -Xmx512m -Xms512m | + | <file java>java -Djava.net.preferIPv4Stack=true -Dsun.stdout.encoding=UTF-8 -Dio.netty.allocator.numDirectArenas=0 -Djdk.nio.maxCachedBufferSize=262144 -XX:+UseSerialGC -XX:+UseStringDeduplication -Xms64m -Xmx512m -XX:CompressedClassSpaceSize=300m -XX:MaxMetaspaceSize=128m -jar ProfitTrailer.jar |
| pause | pause | ||
| - | + | </file> | |
| - | A black CMD Prompt window should appear and the bot is now booting up. Leave this window open - it is the bot! If you close it, the bot will stop. In the CMD Prompt uou will be prompted to complete the rest of the setup using the Web Interface. If you see any errors instead, consult the [[Common Errors]] Page. | + | <---- |
| + | ---->> | ||
| + | A black CMD Prompt window should appear and the bot is now booting up. Leave this window open - it is the bot!\\ | ||
| + | If you close it, the bot will stop. In the CMD Prompt you will be prompted to complete the rest of the setup using the Web Interface. If you see any errors instead, consult the [[https://wiki.profittrailer.com/doku.php?id=common_errors|Common Errors]] Page. | ||
| {{::complete_in_browser.png?nolink|}} | {{::complete_in_browser.png?nolink|}} | ||
| - | + | <---- | |
| - | <WRAP center round important 60%> | + | ---->> |
| - | Leave this window open - it is the bot! If you close it, the bot will stop. | + | |
| - | </WRAP> | + | |
| Your ProfitTrailer bot is now up and running. Congratulations! | Your ProfitTrailer bot is now up and running. Congratulations! | ||
| - | **Now go to http://localhost:8081 if it did not open automatically.** (adjust port if you have used a different one) | + | **Now go to http://localhost:8081 if it did not open automatically.**\\ |
| - | + | (adjust port if you have used a different one) | |
| - | When you open the GUI for the first time you will be asked to set a password. You will also need to enter your [[application.properties#default_api_key]] to confirm you are the owner. | + | <---- |
| + | ---->> | ||
| + | When you open the GUI for the first time you will be asked to set a password. You will also need to enter your default_api_key to confirm you are the owner. | ||
| {{:set_admin_password.png?nolink|}} | {{:set_admin_password.png?nolink|}} | ||
| + | <---- | ||
| + | ---->> | ||
| If successful you will then be asked to Login. | If successful you will then be asked to Login. | ||
| {{::login.png?nolink|}} | {{::login.png?nolink|}} | ||
| - | + | <---- | |
| - | Finally you will be presented with the Config Load screen. See [[faq#how_do_i_save_and_load_different_configurations|Saving/Loading/Importing/Editing Configs]]. | + | ---->> |
| - | + | Finally you will be presented with the Config Load screen. See [[https://wiki.profittrailer.com/doku.php?id=faq#how_do_i_save_and_load_different_configurations|Saving/Loading/Editing Configs]]. | |
| - | There are three methods for choosing your first configuration: | + | <---- |
| - | + | ---->> | |
| - | * **Public** - Choose from our database of public configs and copy it to your bot giving it a unique name. | + | * Public - Choose from our database of public configs and copy it to your bot giving it a unique name. |
| - | * **Saved** - Choose from one of your own configs that you have already created in the past. | + | * Saved - Choose from one of your own configs that you have already created in the past. |
| - | * **Import** - Choose a name and import a config from your ProfitTrailer initialization folder. | + | |
| {{::initial_settings_load.png?nolink|}} | {{::initial_settings_load.png?nolink|}} | ||
| - | ~~DISCUSSION~~ | + | <---- |
| + | ---->> | ||
| + | This concludes the ProfitTrailer Windows Setup Guide | ||
| + | <---- | ||
sgtbatten