Giter Club home page Giter Club logo

av-snapshot's Introduction

av-snapshot

This is a fork of Cheesecookie's cc_snapshot, and works pretty much the same way cc_snapshot does:

  • Upload a snapshot of your character's profile
  • Show off your character to your friends
  • ???
  • Profit!

Contents

  1. License
  2. Installation
  3. Usage
  4. Notes
  5. Frequently Asked Questions

License

License: CC BY-NC-SA 4.0 This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Installation

Run this command in the graphical CLI:

git checkout https://github.com/m-e-meyer/av-snapshot main

Will require a recent build of KoLMafia.

Usage

Just enter av-snapshot into the gCLI. It will gather and upload your information, and then tell you where you can visit your profile, a URL like https://api.aventuristo.net/av-snapshot?u=<username>.

The parameters for viewing snapshots are:

  • u=: The name of the user for which the snapshot was taken. This is the only parameter that is required. If the name has spaces, and your browser doesn't handle them, you can substitute + or %20 for each space.
  • colorblind=: If 0 (the default if not given), colors boxes with greens and reds. If 1, colors boxes with blues and yellows.
  • noimages=: If 0 (the default if not given), the page will be drawn with images. If 1, the page will be drawn without images, which may be faster and will certainly take fewer pages to print.
  • oob=: Stands for "on or before". Takes a string of the form yyyy-mm-dd, where yyyy is the 4-digit year, mm is a month from 01 to 12, and dd is a day from 01 to 31. If this parameter is not supplied or is empty, av-snapshot shows the most recent snapshot. Otherwise, av-snapshot shows the most recent snapshot taken on or before the given date. Partial dates can also be supplied; 2023-01 will give the last snapshot before the end of January 2023.
  • sections=: Comma-delimited list of section names. If not supplied or if empty, the entire snapshot is shown. Otherwise, only the section names given will be shown. If a named section has subsections, then all its subsections will be shown. The entire section name does not need to be supplied; if the first few letters are given, then all sections with names beginning with those letters are shown. For example, f will show the whole Familiars section, as well as Fishin' Gear and FantasyRealm under Cool Items, and Food under Consumption.

For eaxmple, https://api.aventuristo.net/av-snapshot?u=mortigulo&oob=2022&sections=skil,fam will show the Skills and Familiars sections of Mortigulo's last snapshot before the end of 2022.

Notes

Sorry, you can't access cc_snapshot's stored profiles directly from api.aventuristo.net. av-snapshot's backend was built from scratch, and uses a new database. Web pages generated by av-snapshot have links to the cc_snapshot equivalent, though.

Frequently Asked Questions

Why isn't the Mr. Item that I know I have showing up?

Some items are unusual in that they open up places, so they don't appear in your inventory or in your Terrarium. To detect these items, av-snapshot relies on the values of certain properties that should be set by Mafia. If the property is set wrong, av-snapshot won't find it. Sometimes it happens to people who have changed their names; perhaps the properties under the new names need to be updated. Here are the properties used to find certain Mr. Items:

Unlocked Place Property
11th Precinct Headquarters hasDetectiveSchool
Autumn-aton hasAutumnaton
Boxing Daycare daycareOpen
Chateau Mantegna chateauAvailable
Conspiracy Island spookyAirportAlways
cosmic bowling ball hasCosmicBowlingBall
Dinseylandfill stenchAirportAlways
FantasyRealm frAlways
Florist Friar ownsFloristFriar (as of Mafia r27496)
Getaway Campsite getawayCampsiteUnlocked
Gingerbread City gingerbreadCityAvailable
The Glaciest coldAirportAlways
Horsery horseryAvailable
lovebug pheromones lovebugsUnlocked
LT&T Office telegraphOfficeAvailable
MayDay hasMaydayContract
Neverending Party neverendingPartyAlways
Oliver's Place ownsSpeakeasy
PirateRealm prAlways
Shrine to the Barrel god barrelShrineUnlocked
The Snojo snojoAvailable
Spacegate spacegateAlways
Spring Break Beach sleazeAirportAlways
That 70s Volcano hotAirportAlways
Tunnel of L.O.V.E. loveTunnelAvailable
Voting Booth voteAlways (but see below)

If you have Mr. Item above that doesn't show up, go to Mafia's graphical command-line interface (gCLI) and enter

set <property>=true

where <property> is the property in the table above for the place. You should only have to do this once.

Note: Aliisza observed that, in Mafia r27956, if voteToday is true, Mafia sets voteAlways to false. If you're not seeing your Voting Booth in your snapshot, you might want to check this.

av-snapshot's People

Contributors

libraryaddict avatar m-e-meyer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

libraryaddict

av-snapshot's Issues

99.44% pure math link doesn't seem to be handling % sign appropriately

The Wiki Link for 99.44% pure math is breaking as I don't believe its correctly handling the $ character when buildling the link.

Using Chrome.
Copy Link Address on snapshot page gives me:
http://kol.coldfront.net/thekolwiki/index.php/99.44%%20pure%20math

Copy Link Address from google gives me:
https://kol.coldfront.net/thekolwiki/index.php/99.44%25_pure_math

The result is I get taken to a 400.shtml page

Minor issues when using "name change" form.

Minor issue. I just changed account names and the snapshot was pretty good at updating "most" things.

So far I see it missed the following ItoMs which are in use and I'm not rich enough to have spares in the DC:

  1. Chateau Mantegna room key -> The Big Mountains -> Chateau Mantegna
  2. X-32-Fsnowman crate -> The Big Mountains ->The Snojo
  3. LT&T telegraph office deed -> right side of the tracks -> LT&T Office
  4. detective school application -> wrong side of the tracks -> 11th Precinct Headquarters
  5. hear-shaped create -> wrong side of the tracks -> Tunnel of L.O.V.E.

See the snapshots for "djve" (original) and "de nisovan" (new name).

If these need to be set manually, you may want to add the instruction.

Feel free to close this as won't fix as it may be too hard to fix.

chest mimic not detected

I have a chest mimic but av-snapshot doesn't detect it.

Not a big deal but posting here in case it can be fixed. thanks

Caveman Dan's favorite rock URL incorrect

AV Snapshot updated this morning.

The Caveman Dan's rock URL takes me to:
https://kol.coldfront.net/thekolwiki/index.php/Caveman_Dan%27s_Favorite_Rock

This leads to a non-existent wiki entry as the correct URL is:
https://kol.coldfront.net/thekolwiki/index.php/Caveman_Dan%27s_favorite_rock

The 'f' and 'r' in 'favorite rock' need to be lowercase

Voter booth

When running av-snapshot even if you own voter booth and have the "voteAlways" pref set to true. It will change it to false, and not greenbox the voting booth.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.