Menu
▾
▴
Tree [ef0ad0] master / History
Read Me
Simcraft Explorer includes two tools: se and ser. These tools are located in
the bin directory.
For example usage, please see docs/examples.txt
To see help for each tool, provide a -h or a --help. An invalid option
will also bring up a help menu.
If you find bugs, please feel free to contact the author Effinhunter at
effinhunter@gmail.com
******************************* VERY FIRST STEPS ***************************
Download Simcraft from http://downloads.simulationcraft.org/. Extract the
latest version and then set two environment variables to let SE and SER know
where to find your Simcraft executables.
SIMCRAFT_ROOT needs to point to the directory you put Simcraft in
SIMCRAFT_BIN needs to list the simc command line tool (e.g. sim64.exe)
So, if you had downloaded Simcraft and extracted the contents of the zip file
to c:\simcraft, you would set the variables up to point to the following:
SIMCRAFT_ROOT=C:\simcraft\{a folder with a name like "simc-603-7-win64")
SIMCRAFT_BIN=simc64.exe
Unfamiliar with how to set environment variables on Windows?
Best way to set variables permanently is by doing the following:
1.) Go to Start Menu, Right-click on Computer or My Computer.
2.) Click Properties
3.) Click Advanced System Settings
4.) Click Environment Variables
5.) Click New and enter your variables. You'll probably just want to use the
top New button for User-level variables. Set SIMCRAFT_ROOT and SIMCRAFT_BIN
here. SIMCRAFT_ROOT should point to the location that actually has simc64
in it. It's probably going to be something like C:\simcraft\simc-603-7-win64
or something like that.
6.) Close any terminals you had open as they'll not have the environment variable
updates. Open new terminals. You can check if these are set by doing the
following:
echo %SIMCRAFT_ROOT%
If you had set SIMCRAFT_ROOT=C:\simcraft\simc-603-7-win64, then that's what
should print out. If it just says %SIMCRAFT_ROOT% in response, then you've
messed up somewhere, and you'll want to try the list again above.
******************************* EXAMPLE USAGE SEA **************************
In version 0.6.3, the "sea" tool was added to allow targeted Simcraft profiles
of any gear upgrades from Highmaul, Blackrock Foundry, Crafted, or BoE gear
along with your armory information. At the moment, this tool is in an early
prototype phase, but it does have some very powerful features:
1.) You can specify any gear categories or tags that are important to you using
the syntax from the "se" tool, including --gear-check, --gear-enchant, and
--gear-gem. Use -h for help.
2.) You can specify your armory string in the form of country,realm,char, e.g.,
us,area+52,Effinhunter would snag the author's character from the Blizzard
armory
3.) A batch script is generated for running the Simcraft profile and generating
an HTML output that you can browse, just like any other Simcraft result in
the GUI.
Example 1: Generate all Highmaul, max crafted, and world drops for Effinhunter SV spec
%SE_ROOT%\sea -a "us,area+52,Effinhunter" --gear-check "(location=='Highmaul'&&ilvl>=670&&!warforged&&!socketed)||(type=='crafted'&&(bonus_id==527||bonus_id==66/527))||location=='World'" --gear-enchant ms --gear-gem ms -x Effin_SV -p survival -s %SE_ROOT%\profiles\T17M\hunter\all_items
.\Effin_SV_run.bat
Example 2: Generate all Highmaul, max crafted, and world drops for Effinhunter MM spec
%SE_ROOT%\sea -a "us,area+52,Effinhunter" --gear-check "(location=='Highmaul'&&ilvl>=670&&!warforged&&!socketed)||(type=='crafted'&&(bonus_id==527||bonus_id==66/527))||location=='World'" --gear-enchant ms --gear-gem ms -x Effin_MM -p marksmanship -s %SE_ROOT%\profiles\T17M\hunter\all_items
.\Effin_MM_run.bat
******************************* EXAMPLE USAGE SE ***************************
USING SE
"se" is an application to generate simulation profiles. If we want to sim
a complete race breakdown of all gear, specs, talents, and races with action
lists provided in this installer, we would do the following:
se -s %SE_ROOT%\profiles\T17M\hunter
RACES
This will generate a LOT of profiles. So, be wary. Let's narrow down the
generation a bit. First, let's specify a single race of troll.
se -s %SE_ROOT%\profiles\T17M\hunter -r troll
SPECS
Now, let's limit the simulations to Marksmanship (case sensitive)
se -s %SE_ROOT%\profiles\T17M\hunter -r troll -p marksmanship
TALENTS
We can further narrow our scope by specifying the talents we want. For
talents, we use the Simcraft string that will be used in the talent section.
This is a 4 length list of indexes for the last four tiers of talents (the
dps talents). Each entry starts at 1. For example, here is how to
reference talents in Hunter Tier 60.
Tier 60:
1 - Steady Focus (First column in the tier)
2 - Dire Beast (Second column in the tier)
3 - Stampede (Third column in the tier)
To limit our runs to having Thrill of the Hunt, Stampede, Barrage, and
Adaptation, we would specify 3333, like so:
se -s %SE_ROOT%\profiles\T17M\hunter -r troll -p marksmanship -t 0003333
PREFIX
By default, se generates files with a prefix of "Hunter", but you may want
to make it more descriptive for what you are trying to test out. For
instance, for the above, we might do "T17M_Troll_MM" like so
se -s %SE_ROOT%\profiles\T17M\hunter -r troll -p marksmanship -t 0003333 -x T17M_Troll_MM
GEAR
By default, we would include all possible gear profiles, but some gear
configurations may be obviously subpar. For instance, in T17M, the legendary
ring is BiS. We can specify that we want to always wear this ring by
specifying its index in the appropriate gear listing. To understand gear
listings, let's first go over the indexing system in the gear limiter string.
A gear limiter string is at least 15 characters long and each character
corresponds to limiting the following items:
[0] Head [7] Waist
[1] Neck [8] Legs
[2] Shoulders [9] Feet
[3] Back [10] Finger 1
[4] Chest [11] Finger 2
[5] Wrists [12] Trinket 1
[6] Hands [13] Trinket 2
[14] Main Hand Weapon
The rings are indices 10 and 11. So, if we want to equip a certain ring,
we would want to modify one of these two entries with the appropriate item.
To find the items, we look in the source directory (profiles\T17M\hunter in this
case) and check the contents (e.g. finger.txt in this case).
113877;unexploded_explosive_shard;...
113917;cinderwolf_signet;...
118307;spellbound_runic_band_of_unrelenting_slaughter;...
The legendary ring is the 3rd item in this list, which is index 2. So,
to limit the gear to using this ring in first ring slot, we would do:
se -s %SE_ROOT%\profiles\T17M\hunter -l xxxxxxxxxx2xxxx
This would generate all possible profiles that use this legendary ring.
TESTING
If you'd like to run sample configurations to see how many profiles would
be generated, simply pass the -0, --test or --no-generate options like so:
se -s %SE_ROOT%\profiles\T17M\hunter -l xxxxxxxxxx2xxxx --no-generate
You can also debug your configurations with the -g option (--debug)
RUNNING YOUR SIMS
There will be a .bat file generated in the destination directory (default
is current directory) that you can click on or call from inside a command
line terminal. It will begin with the prefix you specified followed by
_run.bat. So, for a default prefix, this file will always be named:
Hunter_run.bat
Click the file and it will execute.
******************************* EXAMPLE USAGE SER ***************************
ser is a bit easier to use because it has less options. You'll need to know
the prefix and output locations used with the "se" tool to generate the
simcraft profiles. Otherwise, the options are pretty straightforward and
you can get help with -h, --help or an invalid option.
Most profiles will simply need to specify source and destination directories
for results and the prefix used to generate with "se". For instance...
ser -d . -s . -x Hunter
This would read simulation results from running Hunter_run.bat and aggregate
them into a report called Hunter_report.txt. You can also generate a BBC
forum post with the -f option like so:
ser -d . -s . -x Hunter -f my_results.txt
Your forum post with BBC codes will be found in my_results.txt
