WoWBench/Installing - Revision history

Bear at 17:06, 7 October 2023

2023-10-07T17:06:05Z

← Older revision		Revision as of 17:06, 7 October 2023
Line 2:		Line 2:

	== AddOn Studio ==		== AddOn Studio ==
	In [[AddOn Studio]] ~~the most current version of~~ [[WoWBench]] comes already installed and ready to run using the built in 'Lua Console'.		In [[AddOn Studio]], [[WoWBench]] comes already installed and ready to run using the built in [[Lua Console]].

	Starting WoWBench in AddOn Studio:		Starting WoWBench in AddOn Studio:

Bear at 17:05, 7 October 2023

2023-10-07T17:05:14Z

← Older revision		Revision as of 17:05, 7 October 2023
Line 2:		Line 2:

	== AddOn Studio ==		== AddOn Studio ==
	[[WoWBench]] comes installed and ready to run using the ~~[[AddOn Studio]]~~ built in 'Lua Console'.		In [[AddOn Studio]] the most current version of [[WoWBench]] comes already installed and ready to run using the built in 'Lua Console'.

	Starting WoWBench in AddOn Studio:		Starting WoWBench in AddOn Studio:

Bear at 17:04, 7 October 2023

2023-10-07T17:04:19Z

← Older revision		Revision as of 17:04, 7 October 2023
Line 20:		Line 20:
	* Cmd prompt - opens a Windows 'cmd.exe' console in the AddOn Studio WoWBench directory. This allows running other WoWBench scripts, managaing files, or using other WoWBench options to start. This would be a very advanced option, and in the context of AddOn Studio, not normally necessary. But may allow to follow trying old options elsewhere in this documentation.		* Cmd prompt - opens a Windows 'cmd.exe' console in the AddOn Studio WoWBench directory. This allows running other WoWBench scripts, managaing files, or using other WoWBench options to start. This would be a very advanced option, and in the context of AddOn Studio, not normally necessary. But may allow to follow trying old options elsewhere in this documentation.

	~~Notes:~~		Only one console may be open at a time in the 'Lua Console'. Starting a new console session effectively ends the last one.
	* Only one console may be open at a time in the 'Lua Console'. Starting a new console session ~~effectivly~~ ends the last one.

	== Windows / Linux installation ==		== Windows / Linux installation ==
Line 56:		Line 55:
	Here are the pieces of config.lua that I changed, and what I changed them to.		Here are the pieces of config.lua that I changed, and what I changed them to.

	This is the setting for ~~wowbench~~ to find all of the necessary WoW files (Interface/AddOns and WTF, etc.) Change this one to your WoW folder, what I have provided below should be the correct location for 99% of the users.		This is the setting for WoWBench to find all of the necessary WoW files (Interface/AddOns and WTF, etc.) Change this one to your WoW folder, what I have provided below should be the correct location for 99% of the users.
	-- The directory where WoW lives (needed for WTF and AddOns folders)		-- The directory where WoW lives (needed for WTF and AddOns folders)
	_WOWDIR = "/Applications/World of Warcraft"		_WOWDIR = "/Applications/World of Warcraft"

Bear at 17:03, 7 October 2023

2023-10-07T17:03:36Z

← Older revision		Revision as of 17:03, 7 October 2023
Line 2:		Line 2:

	== AddOn Studio ==		== AddOn Studio ==
	[[WoWBench]] comes installed and ready to run~~, either on the built-in [[Lua Console]] command line or~~ using the [[AddOn Studio]] built in 'Lua Console'.		[[WoWBench]] comes installed and ready to run using the [[AddOn Studio]] built in 'Lua Console'.

	Starting WoWBench in AddOn Studio:		Starting WoWBench in AddOn Studio:

Bear at 17:02, 7 October 2023

2023-10-07T17:02:43Z

← Older revision		Revision as of 17:02, 7 October 2023
Line 2:		Line 2:

	== AddOn Studio ==		== AddOn Studio ==
	[[WoWBench]] comes installed and ready to run, either on the command line or using the [[AddOn Studio]] built in 'Lua Console'.		[[WoWBench]] comes installed and ready to run, either on the built-in [[Lua Console]] command line or using the [[AddOn Studio]] built in 'Lua Console'.

	Starting WoWBench in AddOn Studio:		Starting WoWBench in AddOn Studio:

Bear: /* AddOn Studio */

2023-10-07T17:01:51Z

AddOn Studio

← Older revision		Revision as of 17:01, 7 October 2023
Line 14:		Line 14:
	Launch options:		Launch options:
	* WoW Bench - starts a plain WoWBench session		* WoW Bench - starts a plain WoWBench session
	* WoW Bench with AddOn - starts a WoWBench session that also loads AddOn of the currently selected project		* WoW Bench with AddOn - starts a WoWBench session that also loads the AddOn of the currently selected project

			Other options:
			* Lua prompt - loads a plain Lua command console, also modified to work like the Lua version in WoW, but with no code or bench environment
			* Cmd prompt - opens a Windows 'cmd.exe' console in the AddOn Studio WoWBench directory. This allows running other WoWBench scripts, managaing files, or using other WoWBench options to start. This would be a very advanced option, and in the context of AddOn Studio, not normally necessary. But may allow to follow trying old options elsewhere in this documentation.

			Notes:
			* Only one console may be open at a time in the 'Lua Console'. Starting a new console session effectivly ends the last one.

	== Windows / Linux installation ==		== Windows / Linux installation ==

Bear: /* AddOn Studio */

2023-10-07T16:51:53Z

AddOn Studio

← Older revision		Revision as of 16:51, 7 October 2023
Line 7:		Line 7:
	* Start AddOn Studio		* Start AddOn Studio
	* Click on 'View > Lua Console' in the main menu		* Click on 'View > Lua Console' in the main menu
	* Find the Lua Console tool window drop down that says 'Choose Shell' and open		* Find the 'Lua Console' tool window drop down that says 'Choose Shell...' and open
	* Click either 'WoW Bench' or 'WoW Bench with AddOn'		* Click either 'WoW Bench' or 'WoW Bench with AddOn'
	* WoWBench will start in the console		* WoWBench will start in the console

Bear: /* AddOn Studio */

2023-10-07T16:51:19Z

AddOn Studio

← Older revision		Revision as of 16:51, 7 October 2023
Line 3:		Line 3:
	== AddOn Studio ==		== AddOn Studio ==
	[[WoWBench]] comes installed and ready to run, either on the command line or using the [[AddOn Studio]] built in 'Lua Console'.		[[WoWBench]] comes installed and ready to run, either on the command line or using the [[AddOn Studio]] built in 'Lua Console'.

			Starting WoWBench in AddOn Studio:
	* Start AddOn Studio		* Start AddOn Studio
	* Click on 'View > Lua Console' in the main menu		* Click on 'View > Lua Console' in the main menu
Line 12:		Line 14:
	Launch options:		Launch options:
	* WoW Bench - starts a plain WoWBench session		* WoW Bench - starts a plain WoWBench session
	* WoW Bench with AddOn - starts a WoWBench session that also loads AddOn of the currently selected project		* WoW Bench with AddOn - starts a WoWBench session that also loads AddOn of the currently selected project

	== Windows / Linux installation ==		== Windows / Linux installation ==

Bear at 16:50, 7 October 2023

2023-10-07T16:50:51Z

← Older revision		Revision as of 16:50, 7 October 2023
Line 1:		Line 1:
	{{tocright}}		{{tocright}}

			== AddOn Studio ==
			[[WoWBench]] comes installed and ready to run, either on the command line or using the [[AddOn Studio]] built in 'Lua Console'.
			* Start AddOn Studio
			* Click on 'View > Lua Console' in the main menu
			* Find the Lua Console tool window drop down that says 'Choose Shell' and open
			* Click either 'WoW Bench' or 'WoW Bench with AddOn'
			* WoWBench will start in the console
			* Clicking the button again will restart WoWBench with a fresh WoWBench session

			Launch options:
			* WoW Bench - starts a plain WoWBench session
			* WoW Bench with AddOn - starts a WoWBench session that also loads AddOn of the currently selected project

	== Windows / Linux installation ==		== Windows / Linux installation ==

Bear: /* Windows / Linux installation */

2020-06-21T01:58:46Z

Windows / Linux installation

← Older revision		Revision as of 01:58, 21 June 2020
Line 2:		Line 2:

	== Windows / Linux installation ==		== Windows / Linux installation ==
	* Unzip the contents of the zip into a directory. Probably ''nowhere near'' your World of Warcraft directory ~~(it's~~ ''not'' an AddOn!). Remember to conserve the directory structure in the zip!		* Unzip the contents of the zip into a directory. Probably ''nowhere near'' your World of Warcraft directory. It is ''not'' an AddOn! Remember to conserve the directory structure in the zip.
	: Below, we will assume you put it in ~~<tt style="border-bottom~~: ~~1px dotted;">~~C:/wowbench~~</tt>.~~		: Below, we will assume you put it in:
	* If you are ~~'''~~not~~'''~~ running under Win32: Download Lua binaries from [~~http:~~//luabinaries.luaforge.net~~/ http://~~luabinaries.luaforge.net/]		C:/wowbench
	: Make sure you get version 5.0.~~<small>(something)</small>~~, as this is what WoW uses		* If you are not running under Win32: Download Lua binaries from [//luabinaries.luaforge.net luabinaries.luaforge.net]
	* Copy ~~<tt style="border-bottom: 1px dotted;">~~config-dist.lua~~</tt>~~ to ~~<tt style="border-bottom: 1px dotted;">~~config.lua~~</tt>~~.		: Make sure you get version 5.1.x, as this similar to what WoW uses
			* Copy 'config-dist.lua' to 'config.lua'.

	At this point, you have a working WoWBench, without access to your already-installed addons nor to your configuration files.		At this point, you have a working WoWBench, without access to your already-installed addons nor to your configuration files.

	You can either:		You can either:
			:1. Keep the default configuration files and copy your AddOn over to
	* Keep the default configuration files and copy your AddOn over to ~~<tt style="border-bottom: 1px dotted;">~~C:/wowbench/wow/Interface/AddOns~~</tt>~~.		C:/wowbench/wow/Interface/AddOns.
			:- or -
	- or -		:2. Edit 'config-dist.lua' to point to your existing WoW directory, player name, etc. It is fairly self-documenting.

	* Edit ~~<tt style="border-bottom: 1px dotted;">~~config-dist.lua~~</tt>~~ to point to your existing WoW directory, player name, etc. It is fairly self-documenting.

	== MacOS X Installation ==		== MacOS X Installation ==
Line 32:		Line 31:
	Following this you'll need to create the config.lua file, and you'll also need to modify the wowbench.lua file.		Following this you'll need to create the config.lua file, and you'll also need to modify the wowbench.lua file.

	===config.lua===		=== config.lua ===
	Here are the pieces of config.lua that I changed, and what I changed them to.		Here are the pieces of config.lua that I changed, and what I changed them to.

Line 53:		Line 52:
	_LUAC = "luac50"		_LUAC = "luac50"

	===wowbench.lua===		=== wowbench.lua ===
	Just one change here, you need to change wowbench to recognize the Mac style of application bundles. So I changed line 173 to:		Just one change here, you need to change wowbench to recognize the Mac style of application bundles. So I changed line 173 to:

Line 60:		Line 59:
	As a final sidenote, I had to actually disable an AddOn to get the AddOns.txt file to be generated, ymmv.		As a final sidenote, I had to actually disable an AddOn to get the AddOns.txt file to be generated, ymmv.

	== Getting started == ~~<div style="margin-left: 3%;">~~		== Getting started ==
	* Continue to [[WoWBench/Getting started]]		* Continue to [[WoWBench/Getting started]]
	* Back to [[WoWBench]]		* Back to [[WoWBench]]

	[[Category:WoWBench\|Installing]]		[[Category:WoWBench\|Installing]]