Scripts on SVN

Bale · Jun 14, 2013

For information about KoLmafia's SVN script updating, please read our wiki!

This thread is now a place for script authors to discuss the listing of scripts in KoLmafia's script manager. If an author wishes to have their script listed in Scripts -> Script Manger, they should provide the following information.

Script name
A link to the script's forum thread
URL of the script's SVN repository
Short description - this needs to be quire short.
Long description - this may contain HTML, but links don't work properly.

That information will then be converted into the following JSON format by me, or if the script author is feeling ambitious he may provide the following himself:

Code:

  {
  "repo": "http://fluxxdog-coding.googlecode.com/svn/trunk/superdrinks/", 
  "author": "fluxxdog", 
  "name": "Superdrinks for Fun and Profit", 
  "forumThread": "http://kolmafia.us/showthread.php?4703-Superhuman-Cocktailcrafting-script", 
  "shortDesc": "Automates making Superdrinks if you have still access", 
  "category": "action", 
  "longDesc": "This script is for whipping up Superhuman drinks. This is intended to be run as part of a beforeBattleScript. If you have your own, or use BestBetweenBattle, you can basically add this:<p style='border:1px solid red;padding:5px 10px 5px 10px;margin-left:40px;margin-right:40px;font-family:monospace;'>import \"superdrinks.ash\";<br />if(stills_available()>0) make_superdrinks();</p>"
 },

Note: In cases where there is more than one primary author, the original author is listed first unless he has become inactive in his script's maintenance in which case the most prolific maintainer will be listed first. There might be many maintainers for a script since scripters on this forum are social creatures.

Bale · Jun 14, 2013

Original first post in this thread follows:

A few people have been asking for a list of which scripts are currently available on SVN. Eventually this will be integrated seamlessly into KoLmafia, but in the meantime, lets make the list! If you want a script added to this, make a post and eventually I'll add it to this master list.

Installation:
If you are new to SVN installation of scripts, then you may desire some instruction.

In KoLmafia's CLI, copy/paste the checkout command. Do this in KoLmafia, not your OS's command line.
You may be asked to confirm before files are added to KoLmafia if it was previously installed. Just click "YES" unless you don't want the script.
Optional step: To ensure these scripts are always up to date, Go to Preferences -> SVN -> Check "Update installed SVN projects on login"

Uninstallation:

The command svn list will reveal the project names of all svn installed scripts. The correct project name (or a distinct substring) needs to be used.
To uninstall the script use the command:
svn delete project-name
Example, to delete OCD Inventory Control the command is:
svn delete bale-ocd

Automated Adventuring Scripts

Name of Script

Primary Author(s)

Brief Description

Checkout Command

autoBasement

Winterbay & Rinn

Automates Fernswarthy's Basement

svn checkout https://svn.code.sf.net/p/winterbay-mafia/autobasement/code/

Bumcheekcend

bumcheekcity & Winterbay

Automatically script an entire ascension

svn checkout https://svn.code.sf.net/p/bumcheekascend/code/bumcheekascend/

BumPork

bumcheekcity

Automatically play Porko

svn checkout https://svn.code.sf.net/p/bumcheekascend/code/bumpork/

CounterChecker

Bale

Manage automation for KoLmafia counters

svn checkout https://svn.code.sf.net/p/bale/counterchecker/code/

Harvest

Ioeth & Banana Lord

A highly customizable KoL farming script

svn checkout https://svn.code.sf.net/p/mafia-harvest/code/

Make Meat Fast

Winterbay & dj_d

Automates item farming based on current mall values

svn checkout https://svn.code.sf.net/p/winterbay-mafia/farm/code/

Nemesis.ash

slyz

Automates the nemesis quest

svn checkout https://svn.code.sf.net/p/slyz-nemesis/code/

PandamoniumQuest

wrldwzrd89

Automates the Pandamonium Quest for your Steel Organ

svn checkout svn://svn.code.sf.net/p/wrldwzrd89-mafia-scripts/code/trunk/pandamonium-quest/

Pork to the Future

guyy

Automates the agua de vida quests

svn checkout https://svn.code.sf.net/p/guyymafia/code/porkfuture/

The Sea

Theraze

Automates all underwater quests

svn checkout https://svn.code.sf.net/p/therazekolmafia/thesea/code/

Slime Tube

Alhifar

Automates the Slime Tube

svn checkout https://svn.code.sf.net/p/slimetube/code/

TrickTreat

guyy

Automates Halloween Trick or Treating

svn checkout https://svn.code.sf.net/p/guyymafia/code/tricktreat/

Action Automation Scripts

Name of Script

Primary Author(s)

Brief Description

Checkout Command

acquireBuff

Rinn

Get a buff from a buffbot

svn checkout https://svn.code.sf.net/p/acquirebuff/code/

Auto Mushroom

rlbond86

Automatically farms mushrooms from Degrassi Knoll

svn checkout http://svn.code.sf.net/p/rlbond86-mafia-scripts/code/auto_mushroom/trunk/

DreadDrunk

guyy

Gives booze to the Dreadsylvania Carriageman

svn checkout https://svn.code.sf.net/p/guyymafia/code/dreaddrunk/

EatDrink

Theraze & dj_d

Optimize your daily diet

svn checkout https://svn.code.sf.net/p/therazekolmafia/eatdrink/code/

Get Skill

Theraze & kitsunenine

CLI accessible skill acquisition

svn checkout https://svn.code.sf.net/p/therazekolmafia/getskill/code/

Manage Store

fronobulax

Autosell or kBay items in your store that don't sell

svn checkout https://svn.code.sf.net/p/kolmafiascripts/shop/code/

OCD Inventory Control

Bale

Complete inventory control system

svn checkout https://svn.code.sf.net/p/bale/ocd/code/

Sushi

Winterbay

Eats best sushi for profit

svn checkout https://svn.code.sf.net/p/winterbay-mafia/sushi/code/

Informational Scripts

Name of Script

Primary Author(s)

Brief Description

Checkout Command

Adventure Advisor

Bale

Advice about adventure locations

svn checkout https://svn.code.sf.net/p/bale/advisor/code/

CanAdv

Theraze & zarqon

Check whether you can adventure at a given location

svn checkout https://svn.code.sf.net/p/therazekolmafia/canadv/code/

CFStat

fronobulax

Fetches and caches price and sales volume from Coldfront

svn checkout https://svn.code.sf.net/p/kolmafiascripts/cfstat/code/

DCQuest

fronobulax

Assists completionists in managing their display case

svn checkout https://svn.code.sf.net/p/kolmafiascripts/dcq/code/

Easy Snapshot Maker

bumcheekcity

Take a snapshot of your character to display

svn checkout https://svn.code.sf.net/p/bumcheekascend/code/snapshot

Guide

Ezandora

Complete Ascension Guide

svn checkout https://github.com/Ezandora/Guide/branches/Release/

Missing Manuel

Turing

Missing Manuel factoids!

svn checkout http://svn.code.sf.net/p/missingmanuel/code/trunk/

Psychose-a-Matic

zarqon

One-stop psychoanalytic jar management

svn checkout https://svn.code.sf.net/p/psychoseamatic/code/

Relay Task List

rlbond86

The ultimate "To Do" list!

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/task_list/trunk/

Skill Planner/CS Tracker

Almighty Sapling

Relay script detailing the characters skills and CS

svn checkout https://almighty-saplings-ash.googlecode.com/svn/trunk/planner/

Superhuman Cocktailcrafting maximizer

rlbond86

Calculates which drinks to superhumanly cocktailcraft

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/cocktailmax/trunk/

Tower Checker

lostcalpolydude

Info about items needed for the Naughty Sorceress' Tower

svn checkout https://svn.code.sf.net/p/towerchecker/code/

Relay Overrides

Name of Script

Primary Author(s)

Brief Description

Checkout Command

Bounty Hunter Helper

rlbond86

Shows average number of turns to complete available bounties

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/bounty_hunter_helper/trunk/

buttonFrenzy

guyy

Improves buttons for all stores

svn checkout https://svn.code.sf.net/p/guyymafia/code/buttonfrenzy/

Character Info Toolbox

Bale & Chez

Skin for the Character Pane

svn checkout https://svn.code.sf.net/p/mafiachit/code/

Charsheet: Skills by Class

Heeheehee, Theraze & Rinn

Groups skills by class on the charsheet

svn checkout https://svn.code.sf.net/p/relay-charsheet/code/

Clan Raidlog Parser

bordemstirs

Parse your clan dungeon Raidlogs

svn checkout https://almighty-saplings-ash.googlecode.com/svn/trunk/raidlogs/

Enhanced Inventory Spoilers

rlbond86 & ckb

Shows item effects/enchantments in inventory

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/enhanced_inventory_spoilers/trunk/

Fax Identification

rlbond86

Tells you what you got from the fax machine

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/fax_tell/trunk/

Improved Guild Trainer

rlbond86

Shows skill descriptions for all these newfangled skills

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/better_trainer/trunk/

Modular Choice Override

rlbond86

Allows overriding of choice adventures

svn checkout https://svn.code.sf.net/p/rlbond86-mafia-scripts/code/modular_choice_override/trunk/

Monster Manuel: Improved

Bale

Lets big monsters be big in KoL's Monster Manuel

svn checkout https://svn.code.sf.net/p/bale/relay/code/Monster_Manuel_Improvement/

Manor Informer

Bale

Get full status on Manor unlocking from ground floor

svn checkout https://svn.code.sf.net/p/bale/relay/code/manor_unlockInfo/

TrophyTastic

guyy

The trophy case de-suckifier

svn https://svn.code.sf.net/p/guyymafia/code/trophytastic/

Woods quest starter

Bale

Get tranfunc and screwdriver when woods are first visited

svn checkout https://svn.code.sf.net/p/bale/relay/code/woods_questStart/

Combat Scripts

Name of Script

Primary Author(s)

Brief Description

Checkout Command

BatMan RE

zarqon

Provides advanced combat HUD and automation in relay browser

svn checkout https://svn.code.sf.net/p/batman-re/code/
(This also automatically installs and uses SmartStasis)

SmartStasis

zarqon

Automates stasis and other times you don't kill a monster

svn checkout https://svn.code.sf.net/p/smartstasis/code/

WHAM

Winterbay

Automate all of combat

svn checkout https://svn.code.sf.net/p/winterbay-mafia/wham/code/
(This also automatically installs and uses SmartStasis)

Function Libraries (For Scripters)

Name of Script

Primary Author(s)

Brief Description

Checkout Command

BatBrain

zarqon

A central nervous system for consult scripts

svn checkout https://svn.code.sf.net/p/batbrain/code/

CLI Links

zarqon

Adds CLI commands to relay scripts

svn checkout https://svn.code.sf.net/p/clilinks/code/

Form of...HTML!

jasonharper

Code library to add input forms for relay scripts

svn checkout https://svn.code.sf.net/p/formhtml/code/

ZLib

zarqon

Zarqon's general function library for scripters

svn checkout https://svn.code.sf.net/p/zlib/code/

Additional Scripts

Name of Script

Primary Author(s)

Brief Description

Checkout Command

BestBetweenBattle

zarqon

Manages gazoodles of between battle stuff

svn checkout https://svn.code.sf.net/p/bestbetweenbattle/code/

LootBot

guyy

Sell dungeon loot, lazily

svn checkout https://svn.code.sf.net/p/guyymafia/code/lootbot/

New Life

Bale

Scripting the birth of a new ascension

svn checkout https://svn.code.sf.net/p/bale/new-life/code/

Theraze's extras

Theraze

Some automation for certain plot points

kingLiberated	svn checkout https://svn.code.sf.net/p/therazekolmafia/kingliberated/code/
preAscension	svn checkout https://svn.code.sf.net/p/therazekolmafia/preascension/code/
postAscension	svn checkout https://svn.code.sf.net/p/therazekolmafia/postascension/code/

[TD]

[TD]

Note: In cases where there is more than one primary author, the original author is listed first unless he has become inactive in his script's maintenance. There may be additional contributing scripters since scripters on this forum are social creatures, but this list is being kept brief.

fewyn · Jun 14, 2013

Thanks Bale! This is super useful.

fronobulax · Jun 14, 2013

fewyn said:
Thanks Bale! This is super useful.

+1

Bale · Jun 14, 2013

fewyn said:
This is super useful.

I'm not sure how useful it really is. If you use a script, you'd learn about its SVN when you check for updates. If you don't already use a script, I don't see how learning it has an SVN will encourage you to change your mind about it. (Except for ChIT where installing it was a major deal without SVN.) What are you using it for?

For me, this list will mostly be useful as a place to start svn.txt once Roippi is ready to integrate it into KoLmafia. That's why I put script author in the table, so that Roippi can easily include that information.

Roippi, are there any additional fields you'll want in svn.txt that I did not include here?

roippi · Jun 14, 2013

We'll probably want an author-written long form description field. There can be some reasonable cap on it like 500 words or whatever, but yeah.

The only mandatory fields will be name and URL, any others will be optional.

(Before people start getting their word processors out, the feature that this file will go into is one to two months away. So, no rush. )

Bale · Jun 14, 2013

Will you also want a short description as above, or will only the long version fit into your vision?

roippi said:
the feature that this file will go into is one to two months away

Ah. Somehow I was thinking it would be sooner. Thank you for helping me ratchet down my impatience. This is terribly exciting to me.

roippi · Jun 14, 2013

Short description might have a place, I don't know. Vision hazy, ask again later. Short form is useful in a static table like that at least.

Bale said:
Ah. Somehow I was thinking it would be sooner. Thank you for helping me ratchet down my impatience. This is terribly exciting to me.

Yeah we are still in the "short term" of the three phase plan. The API is still getting new stuff almost daily. Though the core stuff is stable, so there's really no problem asking lay users to migrate to svn.

Since I'm building the whole thing from scratch, it's important to take the time to plan out some things first before diving in to development. If I realize halfway through that I really want a different underlying data model, I might as well start over to avoid all the headaches caused by switching to a new one. Same deal goes with layouts and component choices, to a lesser degree. After all that, I'll make some mockups, play around with how I want it to look top-down. And then I'll write my first line of code.

But yeah I won't even let myself enter the planning stage while the API is in development. So that, plus the above, plus actual coding time, adds up to a number of weeks.

Winterbay · Jun 14, 2013

You seem to have missed sushi.ash from that list (available fromsvn checkout https://svn.code.sf.net/p/winterbay-mafia/sushi/code/). Also, I'd like to point out that the SVN-version of autoBasement, although mostly stable, is still in a sort of buyer-beware beta form

Bale · Jun 14, 2013

Do you want me to remove autoBasement from the list?

Winterbay · Jun 14, 2013

Nah, I think I'll release it sometime during the day anyway since I think I've ironed out most of the horrible bugs of going from built-in data file to using the new maximizer-command.

fronobulax · Jun 14, 2013

Bale said:
I'm not sure how useful it really is. If you use a script, you'd learn about its SVN when you check for updates. If you don't already use a script, I don't see how learning it has an SVN will encourage you to change your mind about it. (Except for ChIT where installing it was a major deal without SVN.) What are you using it for?

There are several niche scripts I use once and a while. autobasement is an example. I like knowing it has a SVN version so that I can "switch" to SVN now and know I have the latest version next time I need it. That is much more satisfying than running it and having it tell me there is a new version and I take time out to fiddle with that. So the list makes things much more convenient for me.

I'll also say that I am still a little confused about the update transition process. Once a script is in SVN it gets updated without the author doing anything besides a commit. But I'm not sure how smooth the transition is from any of the existing version checking schemes to SVN, so forcing things into SVN makes more sense to me than waiting and hoping that one of the other techniques will clue me in.

Thanks again for maintaining the first post.

Bale · Jun 15, 2013

Thank you for explaining why this is useful to you. I hadn't experienced that point of view.

fronobulax said:
I'll also say that I am still a little confused about the update transition process. Once a script is in SVN it gets updated without the author doing anything besides a commit.

Not necessarily true. Automatic updating is off by default. Just sayin!

Bale · Jun 15, 2013

Added Harvest to the above list: svn checkout https://sourceforge.net/projects/mafia-harvest/

Theraze · Jun 15, 2013

Up to 3 scripts now.
svn checkout https://svn.code.sf.net/p/therazekolmafia/eatdrink/code/
svn checkout https://svn.code.sf.net/p/therazekolmafia/getskill/code/
svn checkout https://svn.code.sf.net/p/therazekolmafia/thesea/code/

EatDrink. No current changes from the last released version that I can remember except it now spams me instead of dj_d. Might be more random changes though.

get_skill. Added Iron Palm and Kung Fu to the last version. Spams me instead of the Beatle.
TheSea. My spam is now in quotation marks. Worked fine before, but... eh, whatever.

Bale · Jun 15, 2013

Two of those were new to this list. Added them.

I would appreciate if future submissions include a link to the relevant thread. That will help a lot.

Theraze · Jun 15, 2013

Apologies... I just grabbed the links and noted that you'd already found them above. Sorry, will try to keep things more organized in the future.

Bale · Jun 15, 2013

Sorry I was so darn efficient.

Actually, I'm not really sorry. Don't let it bother you.

roippi · Jun 15, 2013

Bale said:
[*]You will be asked to confirm before files are added to KoLmafia. Just click "YES" unless you don't want the script.

Minor point: this only happens if they already have the script installed from pre-SVN days. The confirm dialog is a warning about files being overwritten. You could change that "will" to a "may".

Bale · Jun 17, 2013

Added New Life to the above list: svn checkout https://svn.code.sf.net/p/bale/new-life/code/
Added ZLib to the above list: svn checkout https://svn.code.sf.net/p/zlib/code

Scripts on SVN

Minion

Minion

Administrator

Developer

Minion

Developer

Minion

Developer

Active member

Minion

Active member

Developer

Minion

Minion

Active member

Minion

Active member

Minion

Developer

Minion