Difference between revisions of "Help:To Do List"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
(r14389 buy_using_storage())
imported>Bale
(→‎Missing Stuff: elemental planes quest properties)
(48 intermediate revisions by 3 users not shown)
Line 16: Line 16:
  
 
== Missing Stuff ==
 
== Missing Stuff ==
10078: ash function format_dtg
 
10081: ash function format_dtg renamed to be
 
string '''format_date_time(inFormat, dtg, outFormat)'''
 
more info: http://kolmafia.us/showthread.php?8451-time_to_string()-with-parameter&p=64058&viewfull=1#post64058
 
 
Modify examples on proxy record page because of:
 
10122: Add the boolean "fancy" and "candy" fields to item '''proxy records'''.
 
10147: Initial support for "Crimbo 2011" coinmaster: trade candy for Candy Credits
 
10412: Add $skill '''proxy records''': .dailylimit and .timescast
 
10879: Add a boolean "boss" field to $monster[]
 
 
10227: Add the <s>"'''closet empty'''" CLI command, and</s> the '''empty_closet()''' ASH function.
 
 
 
  r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods
 
  r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods
 
r10344 Add '''tavern( string goal )''' ASH function.
 
goal can be "faucet", "baron", or  "explore" (to explore all remaining unexplored squares).
 
r10345 Add ASH '''tavern( "fight" )''' to explore cellar until the Baron's mansion is found
 
and then go in to fight him.
 
 
r10753-6 '''get_goals()''' returns a string[int] containing all the conditions that KoLmafia will
 
try to satisfy. Add g'''oal_exists()''' where you can pass in a goal type (choiceadv, autostop,
 
meat, health, mana, item) and KoLmafia will tell you if there are any goals that match.
 
 
10922: Add '''get_player_id()''' method to ASH
 
 
10937: Add '''minstrel_quest()''' boolean function,
 
which returns true when Clancy has a new quest for you.
 
 
10971: Added boolean '''hippy_stone_broken()''' function
 
 
11023: Make the CLI "attack" command work again. Make "pvp" equivalent to "steal" instead
 
of "attack". Added "swagger" as equivalent to "flowers".
 
 
11055: Added a 2-parameter version of '''to_string()''', where the first parameter can
 
currently be an int or float (other types are possible, but didn't seem
 
useful), and the second is a format string as defined by the Java
 
String.format() method (which in turn is based on C printf() format strings).
 
For example, "%.2f" will output a float with exactly two digits after the
 
(localized) decimal point.
 
 
11110: Add ASH function: '''pvp_attacks_left()'''. This is guaranteed accurate only if you
 
have recently looked at the Fight! page. Tracking of PVP fights gained via
 
consumption or familiar action and initialization at login will come later -
 
after api.php is updated to include the figure.
 
 
Add '''beforePVPScript''' setting which contains a script to be executed before a PVP
 
attack. At the moment, this is only called from the Relay Browser - and only if
 
relayRunsBeforePVPScript is true
 
 
11112: Call beforePVPScript, if present, during automated PVP via the "flowers" command
 
 
11112: Change ASH '''have_outfit()''' to work with custom outfits, as well as normal outfit
 
Add ASH '''is_wearing_outfit()''' to return TRUE if you are currently wearing the
 
specified custom or normal outfit.
 
 
10815: Allow certain ASH constants to be used in custom combat settings.
 
$phylum[] refers to the monster categorization, see the built-in ASH constants documentation for more information.
 
$element[] refers to either the attack or the defense element. As long as one matches, this check will be satisfied. This may limit its usefulness, but we can evaluate it later.
 
$item[] refers to an item that the monster drops. If there are multiple monsters that drop the item, or if you just can't remember which one it is, and your combat strategy happens to depend on it...
 
In order to match, everything that you specify must match. So if you specify an impossible combination, that CCS section will not run.
 
 
[ $element[ spooky ] $item[ hobo nickel ] ]
 
skill entangling noodles
 
skill weapon of the pastalord
 
 
[ bathroom $element[ spooky ] ]
 
attack
 
 
[ $phylum[ beast ] ]
 
skill stomp
 
attack
 
 
11197: new ASH functions:
 
boolean '''is_familiar_equipment_locked()'''
 
-returns true if current familiar equipment is locked, otherwise false
 
void '''lock_familiar_equipment(boolean locking)'''
 
-tries to lock/unlock fam equipment accordingly.
 
 
11208: Add int '''get_clan_id()''' and string '''get_clan_name()''' functions.
 
 
11267: Pass chat events along to '''chatbotscript'''. The sender is an empty string,
 
the channel is "Events", and the message is stripped of its HTML.
 
 
11432: Add '''is_discardable()''' which will return true even if an item can be autosold,
 
so be careful you don't get cheated out of some meat.
 
 
11438: Revert use of gift flag to previous interpretation: KoL has the item marked as
 
a "Gift Item". Instead, change isGiftable() - which is also used by the ASH
 
is_giftable() function - to allow either the "tradeable" or "gift" flags.
 
Fix the item.gift proxy field to return the value of the gift flag, rather than
 
being a synonym for is_giftable().
 
 
11555: Add monster.raw_attack, monster.raw_defense, and monster.raw_hp to return the
 
unmodified stats from monsters.txt.
 
 
11561:  Add monster '''image_to_monster( string )''' ASH function for looking up monster by image file name.
 
Add monster.image proxy field for going the other way.
 
 
11771: experimental: add overloaded maximize() signature in ASH
 
 
'''maximize( string maximizerString, int maxPrice, int priceLevel, boolean simulate, boolean showEquipment )'''
 
 
returns an aggregate of records with each record containing the fields:
 
**display => display text, as it is shown in the maximizer frame
 
**cmd => actual command string that the maximizer runs to get the boost
 
**score => the boost's score
 
**effect => the effect provided by the boost - if applicable. effect[none] if it is equipment.
 
**item => $item[] that is being suggested for use or equipment
 
**skill => $skill[] that is being suggested
 
 
If the showEquipment argument is false, equipment will be omitted from the results.
 
  
 
  r11707: Experimental ASH feature: the main() function of imported scripts can now be
 
  r11707: Experimental ASH feature: the main() function of imported scripts can now be
Line 136: Line 25:
 
  is a single token.
 
  is a single token.
  
r11965: Add my_companion()
+
  r12060: add ASH '''get_moods()''', returns an aggregate of currently defined mood names.
 
 
r11985: Add the "skeleton" CLI command.
 
 
 
r12019: Add "eudora" CLI command
 
 
 
  r12060: add ASH get_moods(), returns an aggregate of currently defined mood names.
 
 
  "mood listall" in the gCLI will also print a list of defined moods.
 
  "mood listall" in the gCLI will also print a list of defined moods.
  
  r12062: add ASH get_outfits() and get_custom_outfits()
+
  r12062: add ASH '''get_outfits()''' and get_custom_outfits()
 
 
r12070: Overloaded version of appearance_rates considers monster queue:
 
appearance_rates( $location[] location, boolean includeQueue )
 
 
 
r12105: maximizerMRULength is now maximizerMRUSize
 
That affects this page: [[Hidden_Features#Most_Recently_Used_Modifier_Maximizer_Expression]]
 
 
 
'''SVN Features added''' by Roippi! SVN integration was (brokenly) implemented in r12141 and more correctly implemented in r12144.
 
 
FOR USERS:
 
* svn checkout <svnurl> - checks out a svn repository and adds the files from the working copy to the appropriate locations.
 
* svn update - updates all of your installed projects and pushes any changes to the appropriate locations.
 
* svn list - lists installed projects.
 
* svn delete <scriptname> - deletes installed projects and the corresponding files that it pushed. <scriptname> fuzzy matches the script names from svn list.
 
 
FOR SCRIPTERS:
 
You can provide a <nowiki>svn://, http://, or https://</nowiki> link to a valid svn repo. The link does not need to be to the root of the repository.
 
At the location specified by the url, there are only four permissible folders:
 
* ccs/
 
* data/
 
* images/
 
* relay/
 
* scripts/
 
 
Any files or directories in the location specified by your url that are not named the above will cause your repo to fail validation and thus it will not be checked out.
 
Within the valid folders, you can nest files however you want.
 
When users check out your project, the files (and nested folders) will be pushed to the corresponding mafia directories.
 
 
r12157: '''svn increment <projectname>''' and '''svn decrement <projectname>''' moves an installed svn project up/down one revision, respectively.
 
'''svn update''' can also take <projectname> argument or a <SVNURL> argument. Or just be blank to update everything.
 
r12177 svn inc/dec does the same thing as svn increment/decrement. Because typing stuff is hard.
 
 
12167: command "'''svn sync'''"
 
 
Looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the WC file is copied over the local copy one.
 
Note that this is very different from "svn update" and indeed does not contact the repository server at all.
 
 
If you are unsure if you want this feature, this is only for people who maintain modifications to the files in their svn/ folders that they want merged in with updates from the repo.
 
If you are just doing checkout/update operations and don't know what this "merging" business is about, you don't need this feature.
 
 
Users who want to automatically sync after update operations can set syncAfterSvnUpdate = true.
 
 
 
r12153: add '''svnUpdateOnLogin''' (global, default false), which runs svn update before breakfast/loginScript.
 
This could be useful if your loginScript has svn dependencies.
 
 
r12188: add global preference '''_svnUpdated'''
 
only do login svn update (mediated by svnUpdateOnLogin) at most once per day.
 
 
 
r12181: add preference '''simpleSvnUpdate''' (global, default true)
 
If true, simply checks if the root of your working copy is at HEAD, skipping it if so.
 
Speeds up the average update operation by 75% (and is probably nicer on servers).
 
Advanced users who have done something like a non-root "svn switch" or are using svn externals should know whether they want to turn this off.
 
 
Again the ticky box goes at the bottom of general preferences, it is soon time for these to be moved to their own page.
 
 
 
r12198 new ash svn functions:
 
boolean '''svn_exists'''( String projectname ) - returns true if a valid working copy named projectname exists in the svn/ folder
 
boolean '''svn_at_head'''( String projectname ) - returns true if projectname exists, is a valid WC, and is currently at the same revision # as the repository.
 
This will hit the repo server, so be nice.
 
 
 
r12206: initial support for automatic svn dependency installation.
 
global preference '''svnInstallDependencies''' (default true) controls whether svn will try to install dependencies.
 
 
Scripters are now allowed to place a file called dependencies.txt in the top-level of a project.
 
Calling it anything else will fail validation, as before. This special file will not be "pushed" to anywhere locally, it will just remain in the working copy folder.
 
On each line of dependencies.txt, you specify one URL to another SVN project.
 
 
 
r12211: preference '''svnShowCommitMessages''' (global, default false) controls whether you want to see new commit messages from svn update operations.
 
 
 
r12215: add ash function: '''record svn_info( String project )'''
 
record has the following fields-
 
 
String url: the url that the project was checked out from
 
int revision: the revision that the working copy is at
 
String lastChangedAuthor: the author who committed the last change
 
int lastChangedRev: the revision that most recently modified this working copy (note, not necessarily the same as revision field)
 
String lastChangedDate: the date/time when lastChangedRevision happened
 
  
 
  r12238: Add _floristPlantsUsed as a comma-separated list and '''florist_available()'''.
 
  r12238: Add _floristPlantsUsed as a comma-separated list and '''florist_available()'''.
Line 248: Line 54:
 
     }
 
     }
 
  }
 
  }
 
r12255: Experimental support for Dad Sea Monkee - untested in-game.
 
- When we first see Dad Sea Monkee, parse the clues and solve for them.
 
- "'''dad'''" CLI command lists the elemental weakness (and spell) for rounds 1-10
 
- element '''dad_sea_monkee_weakness( int round )''' ASH function for consult scripts.
 
 
12657: Add "'''cache clear'''" command to remove all cached images from /images
 
 
12659: New setting - lastImageCacheClear - records the time when you last cleared the
 
image cache. "'''cache'''" command with no arguments reports that time.
 
 
12662: Add '''get_ignore_zone_warnings()'''
 
 
12932: Adds my_discomomentum().
 
 
13088: Make Prismatic Damage a real, if derived, modifier name. It cannot be used in
 
modifiers.txt, bit you can ask for it by name either in ASH or the Maximizer
 
 
13175: Add ash command my_soulsauce().
 
  
 
  13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing  
 
  13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing  
 
  ASH tracing goes into ASH_datestamp.txt
 
  ASH tracing goes into ASH_datestamp.txt
  
  13222: Add preference banishedMonsters to track banishes. Add ash command is_banished($monsterName[name])
+
  13222: Add preference banishedMonsters to track banishes. Add ash command '''is_banished($monsterName[name])'''
 
 
13223: Add "thrall" datatype to ASH.
 
New ASH function: thrall my_thrall()
 
 
 
13234: New ASH functions: to_thrall( int ), to_thrall( string ), to_int( thrall )
 
New proxy fields for thralls: .id, .image, .tinyimage, .skill
 
 
 
13256: Add CLI command to buy or sell from a coinmaster:
 
coinmaster buy nickname item, item ...
 
coinmaster sell nickname item, item, ...
 
 
 
r13280 & r13282: Added Ash functions:
 
'''monster_initiative( [monster] )''' - returns initiative + ML penalty
 
 
 
13299: Add "'''bugbears'''" command to give status of the 9 Bugbear Mothership zones
 
 
 
13393: Added ash function '''stun_skill()''', returns the character's stun skill based on  lass/preferences.
 
 
 
13395: CLI command '''restores''' added, tells you detail on all currently available restores. "restores all" tells you about all restores, "restores obtainable" tells you about all restores that you have or are tradeable.
 
 
 
13576: New ash data type $bounty
 
 
 
13581: Add ash to_bounty() function
 
 
 
13617: Add '''bounty''' CLI command.
 
bounty - lists bounty progress and untaken bounties
 
bounty easy|hard|special - accepts a bounty
 
 
 
13618: Add faxbot ash( $monster ) command. Note that chat must be open for this to successfully work, just as for other mafia fax interfaces.
 
 
 
13638: Add "bjornify" gCLI command, bjornify_familiar( familiar ), and my_bjorned_familiar().
 
 
 
13704: Add "grim" gCLI command to get a Grim Brother effect
 
 
 
13725: Track Audience (only works with character pane at present, request to add to api has been made). Appears on mafia side panel, also available with ash command my_audience().
 
 
 
13927: Relay overrides can be made for specific place.php pages by making a file called (for example) place.plains.ash in the relay folder.
 
The same can be done with shop.php and store.php.
 
 
For place.php?whichplace=plains, place.ash will be used only if place.plains.ash does not exist.
 
 
 
13988: Start tracking elemental planes quests, Hidden Temple quest, Spookyraven Babies quest, from quest log.
 
questESlAudit
 
questESlBacteria
 
questESlCheeseburger
 
questESlCocktail
 
questESlDebt
 
questESlFish
 
questESlMushStash
 
questESlSalt
 
questESlSprinkles
 
questM16Temple
 
questM17Babies
 
  
  r13996: Get turnsplayed from charpane and api and make available in total_turns_played()
+
  r14729: add fixedThreadPoolSize pref - diagnostic/fine tuning for limiting the threadpool size.
 
 
r14012: Adds command "poolskill" which shows your current estimated pool skill, based on current spading on the mechanics.
 
ie. Pool Skill = drunkenness up to 10, -2 for each drunkenness over 10, +1 for each time you've met the pool shark semi-rare up to 10 times,
 
plus bonuses from equipment/effects, plus training in current ascension.
 
 
 
r14017: Add "spookyraven" command. Use "spookyraven on" to track Lights Out all the time.
 
  
 
== Needs Major Work ==
 
== Needs Major Work ==
Line 345: Line 73:
  
 
  Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468
 
  Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468
 
r10025: Added '''choice''' CLI command, to resolve manual or unsupported choiceadventures
 
Added "choice" CLI command, to resolve manual or unsupported choice
 
adventures without having to visit the relay browser - which might be
 
inconvenient if you're already in the CLI, and don't need to see the full
 
adventure text to decide which option you want. With no parameter, "choice"
 
just lists the options. With a numeric parameter, it picks that option.
 
With any other parameter, it picks the first option containing that text (in
 
either the actual button text, or mafia's spoiler text).
 
 
r14389 adds:
 
boolean buy_using_storage( count, item )
 
int buy_using_storage( count, item, max_price )
 
which are like the equivalent buy() functions, but use Meat from storage to get items into storage if you are in Ronin or Hardcore.
 
  
 
== Needs Code Samples ==
 
== Needs Code Samples ==
Line 365: Line 79:
  
 
Information on how to create a code sample: [[Template:CodeSample]]
 
Information on how to create a code sample: [[Template:CodeSample]]
 +
[[Category:Contributing]]

Revision as of 09:38, 17 November 2014

"To Do" List

This is a list of stuff that is missing from the wiki or else needs major work. Please help!


If you need tips for editing the wiki, find that here: Help:Editing.

  • CLI Commands are usually only added to the CLI Reference. Only very complicated commands require their own page.
  • ASH commands need to be listed on their category page as well as on the Ash Functions list.
    • It is not necessary to always create a code sample, although it is preferred.
    • If you don't add a code sample, please remember to add needscode=yes| to the page.


Missing Stuff

r9181, 9183, 9184 & r9190: moods per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods
r11707: Experimental ASH feature: the main() function of imported scripts can now be
invoked, under the alternate name main@filename()
(where 'filename' can be overridden by a 'script' directive, any ".ash"
suffix is dropped, and non-alphanumeric characters are replaced by
underscores). Note that no spaces are allowed around the @, the whole thing
is a single token.
r12060: add ASH get_moods(), returns an aggregate of currently defined mood names.
"mood listall" in the gCLI will also print a list of defined moods.
r12062: add ASH get_outfits() and get_custom_outfits()
r12238: Add _floristPlantsUsed as a comma-separated list and florist_available().
Add "florist plant [plantname]" to add a plant. [plantname] is case-insensitive, but otherwise must exactly match KoL's name for the plant.
Check what is currently planted when you log in.
r12244: Add string [location][int] get_florist_plants()

example 1...
foreach loc, counter, plant in get_florist_plants() {
   print( "Location '" + loc + "'" );
   print( "Counter '" + counter + "'" );
   print( "Plant '" + plant + "'" );
}

example 2...
string [location][int] plants = get_florist_plants();
foreach loc in plants {
   print( "Location '" + loc + "'" );
   string [int] array = plants[ loc ];
   foreach index in array {
       string plant = array[index];
       if ( plant != "" )
           print( "Plant = " + plant );
   }
}
13213: Add "debug ash on" and "debug ash off" to turn on and off ASH script tracing 
ASH tracing goes into ASH_datestamp.txt
13222: Add preference banishedMonsters to track banishes. Add ash command is_banished($monsterName[name])
r14729: add fixedThreadPoolSize pref - diagnostic/fine tuning for limiting the threadpool size.

Needs Major Work

Proxy Records is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring
Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

Needs Code Samples

There is a list of all pages that require code samples: Category:Needs Code Sample

Information on how to create a code sample: Template:CodeSample