Difference between revisions of "Help:To Do List"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
(Added goal information to the page: goal (CLI))
imported>Bale
(Added all the CLI commands!)
Line 16: Line 16:
  
 
== Missing Stuff ==
 
== Missing Stuff ==
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).
 
 
r10033:  a new command 'graygui' (or 'greygui' if you prefer that spelling)
 
has been added to the CLI, which will print out all the entry points for all
 
the stuff that still has a known open request sequence.
 
 
There's also a "location" command, which allows new zones to work like normal with the rest of mafia.
 
 
location 274 Lollipop Forest
 
 
Be careful, if you add the same location twice it can make a mess.
 
Luckily, locations added this way are not remembered, so you can quit and restart if you mess it up.
 
 
 
 
  10078: ash function '''format_dtg'''
 
  10078: ash function '''format_dtg'''
 
  10081: ash function format_dtg renamed to be
 
  10081: ash function format_dtg renamed to be
Line 48: Line 27:
 
  10879: Add a boolean "boss" field to $monster[]
 
  10879: Add a boolean "boss" field to $monster[]
  
  10227: Add the "'''closet empty'''" CLI command, and the empty_closet() ASH function.
+
  10227: Add the <s>"'''closet empty'''" CLI command, and</s> the empty_closet() ASH function.
  
 
  10250: '''kingLiberatedScript''' called when you break the prism.
 
  10250: '''kingLiberatedScript''' called when you break the prism.
Line 60: Line 39:
 
   As soon as I got a potion of inebriety, KoLmafia stopped automating, with  
 
   As soon as I got a potion of inebriety, KoLmafia stopped automating, with  
 
   "Conditions satisfied after 5 adventures".
 
   "Conditions satisfied after 5 adventures".
 
r10281 Add a "'''faxbot''' cmd" command which sends "cmd" to the first configure faxbot.
 
  
 
  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
  
r10343 "'''baron'''" CLI command to find the baron. "'''tavern'''" finds the faucet, as before
 
 
  r10344 Add '''tavern( string goal )''' ASH function.  
 
  r10344 Add '''tavern( string goal )''' ASH function.  
 
  goal can be "faucet", "baron", or  "explore" (to explore all remaining unexplored squares).  
 
  goal can be "faucet", "baron", or  "explore" (to explore all remaining unexplored squares).  
Line 85: Line 61:
 
  command or declaration.
 
  command or declaration.
 
  r10774: ASH: "final" -> "static"
 
  r10774: ASH: "final" -> "static"
 
r10792: Support for Clan Jukebox:
 
- _jukebox is true or false depending on whether you've visited the jukebox
 
- Add jukebox command
 
'''jukebox [#|mod|effect] - listen to a song'''
 
# - 1, 2, 3, 4
 
mod - meat, stats, item, initiative
 
effect - Material Witness, No Worries, Techno Bliss, Metal Speed
 
  
 
  10922: Add get_player_id method to ASH
 
  10922: Add get_player_id method to ASH
Line 98: Line 66:
 
  10937: Add minstrel_quest() boolean function,
 
  10937: Add minstrel_quest() boolean function,
 
  which returns true when Clancy has a new quest for you.
 
  which returns true when Clancy has a new quest for you.
 
10946: Add the "swim" CLI command.
 
  
 
  10971: Added boolean hippy_stone_broken() function
 
  10971: Added boolean hippy_stone_broken() function
Line 114: Line 80:
  
 
  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).
  
 
== Needs Code Samples ==
 
== Needs Code Samples ==

Revision as of 23:46, 14 May 2012

"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

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 "closet empty" CLI command, and the empty_closet() ASH function.
10250: kingLiberatedScript called when you break the prism.
10786: Add afterAdventureScript, which is executed after each automated adventure 
before checking if goals have been satisfied.
 - I did "set afterAdventureScript=use * small box;use * large box"
 - I set my goal to be "+1 potion of inebriety"
 - I told KoLmafia to go to the Dungeon of Doom for 20 adventures.
 After each adventure which yielded a small box or a large box, my script used the box. 
 As soon as I got a potion of inebriety, KoLmafia stopped automating, with 
 "Conditions satisfied after 5 adventures".
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.
r10396 Add "relayRunsBeforeBattleScript" to control whether manual adventuring will
execute your "betweenBattleScript" (which is actually a "beforeBattleScript",
either automated or manual)
r10753-6 get_goals() returns a string[int] containing all the conditions that KoLmafia will 
try to satisfy. Add goal_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.
static scope is added!
r10765: Add a "final" scope type to ASH which allows data/commands to be executed only 
once per session.
r10772: A final declaration can either take a block, surrounded by {}, or a single
command or declaration.
r10774: ASH: "final" -> "static"
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

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
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).

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