The Wiki for Tale 6 is in read-only mode and is available for archival and reference purposes only. Please visit the current Tale 11 Wiki in the meantime.

If you have any issues with this Wiki, please post in #wiki-editing on Discord or contact Brad in-game.

Difference between revisions of "TaleScripts"

From ATITD6
Jump to navigationJump to search
 
(104 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
== Latest Updates ==
 +
<table border=1 cellspacing=0 cellpadding=4 bordercolor=#eaeaea>
 +
<TR>
 +
<TD>Latest <b>Talescript</b> Update:</td>
 +
<TD><b><font color=blue>July 23, 2012</font></b></td>
 +
<TD>[[TaleScripts/Updates|History]]</td>
 +
</tr>
 +
<TR>
 +
<TD>Latest <b>VeggieTale</b> Update:</td>
 +
<TD><b><font color=blue>July 7, 2012</font></b></td>
 +
<TD>[http://bigscreensmallgames.com/ATITD/ History]</td>
 +
</tr>
 +
</table>
 +
 +
Note the update dates are no longer being updated on this page, but doesn't mean Veggie Tales isn't being updated anymore ;)
 +
 +
== News ==
 +
 +
The issue of renaming files with case sensitivity has been fixed on last release. Thanks again Jimbly!
 +
 +
 
== Summary ==
 
== Summary ==
  
−
Talescripts is a community driven project to develop, build and maintain a standard distribution of macros for ATITD.  The problem, currently, is that each macro user must piecemeal together scripts from various sources, and there's no automatic way to sync up and acquire new scripts and bugfixes.
+
Talescripts is a community driven project to develop, build and maintain a standard distribution of macros for ATITD.  The problem, currently, is that each macro user must piecemeal together scripts from various sources, and there's no automatic way to sync up and acquire new scripts and bug fixes.
  
  
−
== Solution ==
+
== Recommended Solutions ==
  
 
Currently, only VeggieTales is supported, but support for AHK and ACTools is provided, if we can get some maintainers for those scripts.
 
Currently, only VeggieTales is supported, but support for AHK and ACTools is provided, if we can get some maintainers for those scripts.
  
−
Note using SVN would be the quickest to install and smallest download for the beginner or novice user to get up and running. Its not as powerful as Git, but you really dont need all the extra features of Git if you are not a developer.
 
  
 +
=== VeggieTales Updater ===
 +
 +
Recommended:
 +
 +
#Run VeggieTales
 +
#Click the Update button (when it glows green in the Luascripts menu or when you see the "Update Talescripts" button in the Main menu.
 +
#Otherwise clicking the Update button will sync your folder back to the last known Talescripts version (undo and backup any locally modified files).
  
  
Line 18: Line 45:
 
# use https://github.com/Vaevictusnet/Talescripts as your target
 
# use https://github.com/Vaevictusnet/Talescripts as your target
 
# go into your c:\TaleScripts\trunk\VeggieTales folder and enjoy!
 
# go into your c:\TaleScripts\trunk\VeggieTales folder and enjoy!
−
 
  
  
Line 32: Line 58:
  
  
−
== Syncing ==
+
== Syncing (Updating to Latest Copy) ==  
−
* Just use SVN Update or Git Pull with the default options. These options are accessible by right clicking the Talescript folder (in Windows Explorer/My Computer).
+
<b>VeggieTales v1.6.0+:</b>
−
* Synching is the same thing as 'Check for Updates' and patch any files that are needed.
+
* Click the Update button
−
 
 
−
 
 
−
== Creating a Shortcut ==
 
−
You can manually create a shortcut (icon) on your Desktop, for the new VeggieTales folder/program. Note Talescripts does not include an installer program. Even though it contains the original VeggieTales.exe, you will need to create a shortcut or manually launch VeggieTales.exe from the Talescripts folder.
 
−
# Right click an empty area on your desktop
 
−
# Choose Create Shortcut
 
−
# Browse to and select "C:\TaleScripts\VeggieTales\VeggieTales.exe" file.
 
  
  
 +
<b>Git/SVN options:</b>
 +
* Just use <b>SVN Update</b> or <b>Git Pull</b> with the default options. These options are accessible by right clicking the Talescript folder (in Windows Explorer/My Computer).
 +
** Synching is the same thing as 'Check for Updates' and patch any files that are needed.
  
  
 
== Developers ==
 
== Developers ==
−
* Use Git, for best results. Fork and talk to Vae, Cegaiel, or KasumiGhia about getting pulled into the main release.  We can assist if you're unfamiliar with the tools.
+
* Use Git, for best results. Fork and talk to Vae, Cegaiel, Tallow or KasumiGhia about getting pulled into the main release.  We can assist if you're unfamiliar with the tools.
−
 
 
−
 
 
−
== Latest Updates ==
 
−
Note in addition to the below summmary, you can also view updates to the repository such as: compare files, see the before and after in the macro source code, etc at https://github.com/Vaevictusnet/Talescripts
 
−
 
 
−
 
 
−
* Mar 24, 2012
 
−
** ADD/REPLACE <b>glass.lua</b> with Skyfeather's update - More time efficient and doesn't need to stop making glass items to spike the temperature. Nice job!
 
−
** ADD <b>window_unpin.lua</b> by Cegaiel - Will right click all windows to unpin them. Note the word 'This' must be visible in the windows for it to be clicked. I find this handy after running 20-25 thistle gardens. Yes this will even unpin windows that are overlapping each other, such as when you use the thistle_new layout (from window_arranger.lua).
 
−
** UPDATE <b>brick_rack.lua</b>, <b>kettles_full.lua</b> and <b>kiln.lua</b> with the above unpin routines. It now will pause and wait for the Shift key before proceeding to unpin. Occassionally I get errors if I do not put ATITD window in focus first (even in high priority mode). This will fix that issue by waiting for you to put ATITD in focus first (if needed). Also removed unpin.png as it is no longer needed.
 
  
  
 +
== Updates History ==
 +
Note in addition to the below link (View All Updates), you can also view updates to the repository such as: compare files, see the before and after in the macro source code, etc at https://github.com/Vaevictusnet/Talescripts
  
−
*Mar 19, 2012
 
−
** UPDATE <b>windows_arranger.lua</b> - Added paper press, brick racks and kiln layouts.
 
−
** Removed some redundant images from VT folder and images not being used.
 
−
** REPOST <b>Forge.inc</b>, uploaded wrong one yesterday
 
−
** DELETE <b>kettle_unstoked.lua</b> (as the unstoked functions are still included in below <b>Kettle_Full.lua</b>.
 
  
−
* ADD - the following macros from Bardoth:
+
Updates have been moved since this section is getting large:
−
** <b>Brick_Rack.lua</b> - Also tweaked it by adding his "Unpin Windows" button from the Kettle Full script - Nice feature!
 
−
** <b>Kiln.lua</b> - Also tweaked it by adding his "Unpin Windows" button from the Kettle Full script - Nice feature!
 
−
** <B>Kettle_Full.lua</b> - Runs stoked and unstoked kettles.
 
−
** <b>Hackling_Rake.lua</b> - Runs hackling rake and will only click if none of your skills are in the red.
 
−
** <b>Wheat.lua</b> - Keeps your wheat beds watered and harvests them when its time.
 
  
 +
[[TaleScripts/Updates | View All Updates]]
  
  
−
* Mar 17, 2012
+
== Bugs, Errors, Suggestions ==
−
** FIX <b>Forge.inc</b> script - Got broken during last update, this is now fixed.
 
−
** ADD <b>Simon.lua</b> macro by Tallow - Allows you to set click points and it will repeat the pattern. Idea for pinning up a menu, such as paints and have it repeat upon demand.
 
  
 +
Any ideas, requests, comments, bugs, etc? Please use the [[Talk:TaleScripts | Discussion]] page.
  
−
* Mar 10, 2012
 
−
** Added <b>Casting.lua</b> / Casting.inc - Casting Box macro by Bardoth
 
−
** Adjusted project times on <b>Forge.inc</b> (added Jan 29) to have less gaps between projects. There was 30s gap on 10 min projects and 60s gap on 15m projects (gap meaning the time between a project getting done and when the next one was clicked to start). Previously the formulas were 70s * project time (ie 70*15000 for a 15m project) which causes the times to drift over time. Times are now in Teppy Time: 1m = 66s + 3 seconds 'safety net' in case of lag (total 69s), etc. I also applied the new times to <b>Casting.inc</b> macro before adding it...
 
  
 +
==VeggieTales Info==
 +
[[Jimbly's Macros | View Jimby's Macro page]] for more information about VeggieTales.
  
−
* Feb 24, 2012
+
Official VeggieTales app page: [http://www.bigscreensmallgames.com/ATITD/ http://www.bigscreensmallgames.com/ATITD/]
−
** Added <b>Crematory.lua</b> - Crematory macro by Tallow
+
----
  
  
−
* Feb 22, 2012
+
<b><i><font color=maroon>Latest VeggieTales updates:</font></i></b>
−
** Furthur fine tuning to <b>onions2.lua</b>. All updates/tweaks explained in Onions2_update_notes.txt which is included in the luascripts folder.
 
  
  
−
* Jan 29, 2012
+
<b><font color=#060a86>You no longer need to use SVN or Git programs to get your updates, or dont even need it installed.
−
** More powerful barley script added: needs a Warehouse and Rain Barrel though
+
<BR>Just click the update button, in VeggieTales, to update the latest Talescripts updates!</font></b>
−
** Added Forge script by T5 Darkfyre. Also fixed the 'image nill' error on Sheeting and Wire!
 
−
** Fishing Script!
 
−
** Watermine!
 
−
** Strength Monitor!
 
−
** Multiple Barrel Vise!
 
−
** Improved Onions
 
−
** Improved Flax
 
−
** Instructions!
 
  
  
−
==Current File List==
+
* <b>Update button:</b> Click it to automatically download files AND sync from the current Talescripts version.
 +
**There is an Update button that appears in two locations. 1) There is always an update button inside the Luascripts menu. This Update button will glow green when it detects there is an update. 2) <u>Only</u> when an update is detected, it will also show a non glowing "Update Talescripts" button on the main menu. So its very hard to miss when a new update is available.
 +
***But it won't glow green (in luascripts menu) unless it detects there's been a new update on Talescripts.
 +
***If you make local changes, you can always click Update to get it to sync back to the old version.
  
−
This is the current file list as of <b><font color=blue>Saturday, Mar 24, 2012</font></b>.
+
* <b>Backup routine:</b> Any files that exist, that has been modified since the last update, will be renamed from foo.lua to foo.000. If foo.000 exists, then leave foo.000 alone and back up to foo.001, .002, etc. So this means if you was tweaking something and apply an update, it will rename your work to .000, .001, so its not permenantly lost. It will backup to a maximum of .005 and then start overwriting .000, 001, etc).
−
 
+
* <B>New Reference File:</b> <u>ScriptingReference.txt</u> which will have the VeggieTales scripting reference.  
−
This only shows the 'luascripts' folder inside of Talescripts.
+
* <b>New Reference File:</b> <u>ThistleReference.txt</u> - Notes about using Thistle Mode.
−
 
+
* <b>Directory Restructure:</b> All image/sound files (.png/.wav) is now located in its own folder, <b>/images</b> folder, instead of the main/root folder. Finding all of the .txt config/reference/log files will be easier to find in the main folder, now that they're not buried amongst many image files. This provides a cleaner root folder. So now when using a function like <i>findAllImages(This.png);</i> it would look in the 'images' folder (for This.png file) instead of the main folder. For different folders use <i>findAllImages(Fishing/image.png);</i> to look in the /images/fishing folder, etc (v.1.6.1).
−
<!-- Note this file is auto generated at http://mike.sharpnetwork.net/atitd/talescript.asp -->
+
* <b>Secured LUA execution</b> so that it does not allow access to the OS module (running external programs) nor file I/O outside of text files in the VeggieTales directory. In other words, you can not access files outside the VeggieTales folder (malicious activity) (v.1.6.2).
−
 
+
*<b>Fixed</b> various screen scraping functions to throw an error if they are called before srReadScreen instead of crashing. Added lsMouseIsDown for polling mouse state (v1.6.3).
−
<table border=1 cellspacing=0 cellpadding=4>
+
* <b>Added integrated self-update of program executable</b>. Executable updates can only be pushed from Jimbly, not GitHub. In other words, with this version, you should never need to use an installer file for future updates. Even VeggieTales.exe will self update in future (but only by Jimbly on his end, so you will know its from a reputable source) (v.1.6.4).
−
<tr bgcolor=#eaeaea><td><b>File Name</b></td><td><b>File Size</b></td></tr>
+
*<b>Fixed</b> slow srGetWindowBorders (window_manager.lua).  Added lsClipboardGet, lsClipboardSet. (v1.6.5).
−
<tr><td>acro.lua</td><td>881</td></tr>
+
*<B>Added OCR</b> Text Recognition (Skyfeather) (v1.6.7)
−
<tr><td>barley.lua</td><td>10,651</td></tr>
+
*<b>Fix</b> for alpha issue with OCR (Tallow) (v1.6.8). The OCR functions (added in v1.6.7) should now work on all video cards now or at least most.
−
<tr><td>barley2.lua</td><td>13,703</td></tr>
 
−
<tr><td>barrel_grinder.lua</td><td>2,667</td></tr>
 
−
<tr><td>barrel_vise.lua</td><td>7,792</td></tr>
 
−
<tr><td>boards.lua</td><td>1,753</td></tr>
 
−
<tr><td>brick_rack.lua</td><td>6,061</td></tr>
 
−
<tr><td>Casting.inc</td><td>16,830</td></tr>
 
−
<tr><td>Casting.lua</td><td>4,043</td></tr>
 
−
<tr><td>cc_Assist.lua</td><td>3,454</td></tr>
 
−
<tr><td>chem_helper.lua</td><td>29,418</td></tr>
 
−
<tr><td>clay.lua</td><td>5,741</td></tr>
 
−
<tr><td>click_max.lua</td><td>1,096</td></tr>
 
−
<tr><td>crematory.lua</td><td>19,177</td></tr>
 
−
<tr><td>cut_stones.lua</td><td>2,366</td></tr>
 
−
<tr><td>essences.lua</td><td>14,838</td></tr>
 
−
<tr><td>Fishing.lua</td><td>12,556</td></tr>
 
−
<tr><td>Fishing_Func.inc</td><td>4,438</td></tr>
 
−
<tr><td>flax.lua</td><td>8,061</td></tr>
 
−
<tr><td>flax_common.inc</td><td>8,290</td></tr>
 
−
<tr><td>flax_seeds.lua</td><td>6,680</td></tr>
 
−
<tr><td>forge.inc</td><td>31,883</td></tr>
 
−
<tr><td>forge.lua</td><td>4,134</td></tr>
 
−
<tr><td>glass.lua</td><td>8,749</td></tr>
 
−
<tr><td>hacking_rack.lua</td><td>2,811</td></tr>
 
−
<tr><td>kettle_full.lua</td><td>16,065</td></tr>
 
−
<tr><td>kiln.lua</td><td>7,806</td></tr>
 
−
<tr><td>mining_t5.lua</td><td>6,214</td></tr>
 
−
<tr><td>multi_click.lua</td><td>2,726</td></tr>
 
−
<tr><td>onions.lua</td><td>8,284</td></tr>
 
−
<tr><td>onions2.lua</td><td>11,797</td></tr>
 
−
<tr><td>onions2_update_notes.txt</td><td>8,089</td></tr>
 
−
<tr><td>paint_watch.lua</td><td>5,605</td></tr>
 
−
<tr><td>paper_press.lua</td><td>2,758</td></tr>
 
−
<tr><td>papyrus.lua</td><td>4,683</td></tr>
 
−
<tr><td>pump.lua</td><td>783</td></tr>
 
−
<tr><td>quarry.lua</td><td>7,494</td></tr>
 
−
<tr><td>raeli_color_mon.lua</td><td>2,719</td></tr>
 
−
<tr><td>sand_mine.lua</td><td>1,905</td></tr>
 
−
<tr><td>screen_reader_common.inc</td><td>1,726</td></tr>
 
−
<tr><td>silt.lua</td><td>3,889</td></tr>
 
−
<tr><td>simon.lua</td><td>3,695</td></tr>
 
−
<tr><td>single_click_stat_mon.lua</td><td>2,196</td></tr>
 
−
<tr><td>single_click_Strength_mon.lua</td><td>1,667</td></tr>
 
−
<tr><td>testScript.lua.example</td><td>650</td></tr>
 
−
<tr><td>thistle_custom.lua</td><td>6,483</td></tr>
 
−
<tr><td>thistle_new.lua</td><td>8,540</td></tr>
 
−
<tr><td>thistle_new_updown.lua.beta</td><td>9,162</td></tr>
 
−
<tr><td>timer.lua</td><td>776</td></tr>
 
−
<tr><td>UITest.lua.example</td><td>1,115</td></tr>
 
−
<tr><td>ui_utils.inc</td><td>4,510</td></tr>
 
−
<tr><td>watermine.lua</td><td>4,554</td></tr>
 
−
<tr><td>wheat.lua</td><td>3,367</td></tr>
 
−
<tr><td>window_arranger.lua</td><td>4,098</td></tr>
 
−
<tr><td>window_opener.lua</td><td>1,519</td></tr>
 
−
<tr><td>window_unpin.lua</td><td>1,608</td></tr>
 
−
<tr><td>wood.lua</td><td>2,608</td></tr>
 
−
</table>
 

Latest revision as of 04:00, 4 February 2014

Latest Updates

Latest Talescript Update: July 23, 2012 History
Latest VeggieTale Update: July 7, 2012 History

Note the update dates are no longer being updated on this page, but doesn't mean Veggie Tales isn't being updated anymore ;)

News

The issue of renaming files with case sensitivity has been fixed on last release. Thanks again Jimbly!


Summary

Talescripts is a community driven project to develop, build and maintain a standard distribution of macros for ATITD. The problem, currently, is that each macro user must piecemeal together scripts from various sources, and there's no automatic way to sync up and acquire new scripts and bug fixes.


Recommended Solutions

Currently, only VeggieTales is supported, but support for AHK and ACTools is provided, if we can get some maintainers for those scripts.


VeggieTales Updater

Recommended:

  1. Run VeggieTales
  2. Click the Update button (when it glows green in the Luascripts menu or when you see the "Update Talescripts" button in the Main menu.
  3. Otherwise clicking the Update button will sync your folder back to the last known Talescripts version (undo and backup any locally modified files).


SVN option

  1. Install TortoiseSVN: http://tortoisesvn.net/downloads.html
  2. Create C:\TaleScripts
  3. right click on C:\TaleScripts and select SVN Checkout
  4. use https://github.com/Vaevictusnet/Talescripts as your target
  5. go into your c:\TaleScripts\trunk\VeggieTales folder and enjoy!


Git option

  1. Install msysgit: http://code.google.com/p/msysgit/downloads/list
    • Should be the file that looks like: msysGit-netinstall-#.#.#-preview#.exe
  2. Install TortoiseGIT: http://code.google.com/p/tortoisegit/downloads/list
    • get the latest version for your system 64-bit or 32-bit
  3. Create C:\TaleScripts
  4. right click on C:\TaleScripts and select Git Clone
  5. use git://github.com/Vaevictusnet/Talescripts.git as your URL
  6. go into your c:\TaleScripts\VeggieTales folder and enjoy!


Syncing (Updating to Latest Copy)

VeggieTales v1.6.0+:

  • Click the Update button


Git/SVN options:

  • Just use SVN Update or Git Pull with the default options. These options are accessible by right clicking the Talescript folder (in Windows Explorer/My Computer).
    • Synching is the same thing as 'Check for Updates' and patch any files that are needed.


Developers

  • Use Git, for best results. Fork and talk to Vae, Cegaiel, Tallow or KasumiGhia about getting pulled into the main release. We can assist if you're unfamiliar with the tools.


Updates History

Note in addition to the below link (View All Updates), you can also view updates to the repository such as: compare files, see the before and after in the macro source code, etc at https://github.com/Vaevictusnet/Talescripts


Updates have been moved since this section is getting large:

View All Updates


Bugs, Errors, Suggestions

Any ideas, requests, comments, bugs, etc? Please use the Discussion page.


VeggieTales Info

View Jimby's Macro page for more information about VeggieTales.

Official VeggieTales app page: http://www.bigscreensmallgames.com/ATITD/


Latest VeggieTales updates:


You no longer need to use SVN or Git programs to get your updates, or dont even need it installed.
Just click the update button, in VeggieTales, to update the latest Talescripts updates!


  • Update button: Click it to automatically download files AND sync from the current Talescripts version.
    • There is an Update button that appears in two locations. 1) There is always an update button inside the Luascripts menu. This Update button will glow green when it detects there is an update. 2) Only when an update is detected, it will also show a non glowing "Update Talescripts" button on the main menu. So its very hard to miss when a new update is available.
      • But it won't glow green (in luascripts menu) unless it detects there's been a new update on Talescripts.
      • If you make local changes, you can always click Update to get it to sync back to the old version.
  • Backup routine: Any files that exist, that has been modified since the last update, will be renamed from foo.lua to foo.000. If foo.000 exists, then leave foo.000 alone and back up to foo.001, .002, etc. So this means if you was tweaking something and apply an update, it will rename your work to .000, .001, so its not permenantly lost. It will backup to a maximum of .005 and then start overwriting .000, 001, etc).
  • New Reference File: ScriptingReference.txt which will have the VeggieTales scripting reference.
  • New Reference File: ThistleReference.txt - Notes about using Thistle Mode.
  • Directory Restructure: All image/sound files (.png/.wav) is now located in its own folder, /images folder, instead of the main/root folder. Finding all of the .txt config/reference/log files will be easier to find in the main folder, now that they're not buried amongst many image files. This provides a cleaner root folder. So now when using a function like findAllImages(This.png); it would look in the 'images' folder (for This.png file) instead of the main folder. For different folders use findAllImages(Fishing/image.png); to look in the /images/fishing folder, etc (v.1.6.1).
  • Secured LUA execution so that it does not allow access to the OS module (running external programs) nor file I/O outside of text files in the VeggieTales directory. In other words, you can not access files outside the VeggieTales folder (malicious activity) (v.1.6.2).
  • Fixed various screen scraping functions to throw an error if they are called before srReadScreen instead of crashing. Added lsMouseIsDown for polling mouse state (v1.6.3).
  • Added integrated self-update of program executable. Executable updates can only be pushed from Jimbly, not GitHub. In other words, with this version, you should never need to use an installer file for future updates. Even VeggieTales.exe will self update in future (but only by Jimbly on his end, so you will know its from a reputable source) (v.1.6.4).
  • Fixed slow srGetWindowBorders (window_manager.lua). Added lsClipboardGet, lsClipboardSet. (v1.6.5).
  • Added OCR Text Recognition (Skyfeather) (v1.6.7)
  • Fix for alpha issue with OCR (Tallow) (v1.6.8). The OCR functions (added in v1.6.7) should now work on all video cards now or at least most.
Retrieved from "http://www.atitd.org/wiki/t6w/index.php?title=TaleScripts&oldid=250781"