NGLister 2.0.1 Readme (c)2005 JF Software Joshua Foster / ShittyKitty http://www.jfsoftware.com (Note: This document looks better with Word Wrap turned on!) DESCRIPTION =========== NGLister allows for the automation of the retrieval of profile data when making ranking lists of Newgrounds members. It is especially designed for those people using Excel spreadsheets to create ranking lists. WARNINGS ======== * Automation file specifications have been moved to the definition file readme. Check the "definition readme.txt" file that came in the ZIP file with your NGLister program, or in the folder containing NGLister. * New in version 2.0.x is a "definition file" system, allowing easier updates to specific parts of the program. If you update your definition file, be EXTRA careful to keep the nglister.ngl file in the same folder as your NGLister program. Otherwise, NGLister won't be able to find your definition file and will revert to the built-in (older) file. * When you start version 2.0.x for the first time (or any time you remove the nglister.ngl file), you will be told that the definition file was "missing or invalid" and you will be prompted if you want to use the built-in file. Click Yes, or the program will exit. WHAT'S NEW ========== Version 2.0.1 * Major bug fix: * Deselecting any of the grabbers prevented data pulls * Fixed the Load Definitions button * Made the "locked grabber" system a little more user-friendly Version 2.0 * New maintenance system, using definition files * Automatic version checking and definition updates * Built reg request program into main program * Added drag-and-drop ability * Added an About screen Version 1.6.1 * Temporary fix release * Fixed review grabber to reflect new profile HTML code * Alternate method available for getting vagrant profile names * Status display when loading input file Version 1.6 * 2 new grabbers: - Review Res. - RR Rate * Pretty new NG tank icon Version 1.5.2 * Found out I can't spell "deity"; fixed spelling error in output Version 1.5.1 * Tab-based interface * 3 new grabbers: - Blam+Save - Whistle - Aura * Shows status when minimized * Plays sound and restore when finished Version 1.5 * Completely new, more stable grabber codes * Added Awards grabber * Browsing for Input file changes Output paths Version 1.4.1 * Fixed single-review problem Version 1.4 * Added software registration Version 1.3 * Tolerance for missing stats * Fixed Sign-Up Date grabber * Automatically take numbers out of URLs * Output lists disabled until checked * New automation method * Pause/Stop buttons Version 1.2 * Added Exp Rank, B/P Rank, and Sign-Up Date (non-functional) grabbers Version 1.1 * Empty profile values * Multiple lists at one time * Batch-file automation Version 1.0 * First public release INTRODUCTION ============ To create an input profile list, copy a single column of profile numbers from Excel into a text file, and save the text file. This must be one single column, and it must all be numbers or Newgrounds profile URLS. The order of the numbers doesn't matter, but the output data will be returned in this same order. Example: If this is your input file: 1 http://www.newgrounds.com/gold/profile/template.php3?id=2 http://www.newgrounds.com/gold/profile/template.php3?id=3 4 And this is your output file: 3423 3466 7876 12 Then user #1 has 3423 whatevers, user #2 has 3466, user #3 has 7876, and user #4 has 12. NGLister doesn't sort or total any data; it expects you to use a program such as Excel for this purpose. USING NGLISTER ============== When you start NGLister, it checks for online updates. If a program update is found, you will be notified and asked if you'd like to open the download page. If a definition file update is found, you will be asked if you'd like to update. The program will download the new definition file, install it for you, open the definition file's readme document, and prompt you to restart the program. Be sure to read that readme document, especially if you're using automated settings files. To manually update your definition file (for instance, if you've downloaded or edited one yourself), click the "Load Definitions" button. Browse for the definition file you wish to use, and the program will check the file for validity and restart itself. You can have NGLister return a certain value for empty profiles (ones that have been deleted or not yet verified / created). Change the textbox next to "Data Returned For Empty Profiles" below the "Data To Retrieve" box to use this feature. Click the Browse button for the Input file (or drag-and-drop a file onto the Input file textbox), select which Data lists you want to Retrieve and Browse for a file to save each list to (or drag-and-drop a file onto each Output file textbox), change the Empty Profile value, then click the Start button to start acquiring data. The progress bar at the bottom of the window will indicate the program's current progress, while the "Ready" label below the bar will show the program's status. While the program is running, the Start button becomes a Stop button, and the Load Settings button becomes a Pause button. Clicking Pause will bring up a small dialog box; click OK on this box to resume the program. Clicking Stop will stop the program. ERROR SITUATIONS ================ There are a few problems that might occur: * A dialog box stating "Error while opening input file or reading contents!" Either the program was unable to open your selected input file, or the contents aren't a single column of numbers / URL's. * A dialog box stating "Error while opening an output file!" The program was unable to write to one of your selected output files. * The status label (below the bar) says "Connection error #X on user #Y" For some reason the program is unable to download the profile for user Y, and it's tried X times. When the program encounters a problem like this, it will keep trying until it works. Usually this problem is due to a server problem (on Newgrounds' end) or an Internet connection problem (on your end). Try disconnecting and reconnecting your Internet access; the program will automatically start downloading new profiles when it finds a connection. * A dialog box stating "Error while writing to an output list!" Either the program was unable to write to one of your selected output files, or it had some other problem while trying to write to the file. In any case, send a copy of the EXACT error message and send it to joshua70448@gmail.com, just in case it's a coding problem that needs to be fixed. * A dialog box stating "Error while opening settings file or reading contents!" Either the program was unable to open your settings file, or you didn't format the settings file correctly. For information on formatting a settings file, check the "definition readme.txt" file that came in the ZIP file with your NGLister program, or in the folder containing NGLister. (Make sure that you leave blank lines if you're not using an output file) (Make sure you've fixed any older automation files) * A dialog box stating "Invalid definition file!" Something is wrong with the formatting of the definition file you are using or trying to use. Contact the person you got the definition file from (usually me) with the exact error message. If this happens with the definition file you are currently using, the program will ask you if you'd like to use the built-in definition file. This will allow you to use the program, but will not include any features that have been added since the release of that program version. If you have any questions, problems, or suggestions, feel free to email me at joshua70448@gmail.com. REGISTRATION ============ Note: If you registered NGLister previously, then you don't have to register again. To prevent a proliferation of list creations, a registration function was added to NGLister 1.4. Don't worry, registration's free, but not everyone will be accepted. NGLister will not run unless you register it first. To register NGLister, run the program. The registration prompt will appear, instead of the normal program. You will be given a registration request code, along with these instructions: "Along with your registration request, you must provide convincing evidence that your proposed list(s) is/are useful to the Newgrounds community. Be sure to include your Newgrounds username. If I (ShittyKitty) am not convinced of your list(s) usefulness / necessity, I will reject your request. If you think you can steal a registration code from someone else, think again. Reg codes are built for one machine and one machine only. To submit your registration request, email the above registration request code and your essay to joshua70448@gmail.com." I do not appreciate attempts at piracy. This program has selective registration for a reason: to prevent the flooding of NG forums with useless lists and the over-consumption of NG bandwidth. If you don't like how I do things, make your own damned program. PROGRAM INFO ============ To get version info for NGLister, click the "About..." button on the main screen. This will give you program version and definition file version information, along with contact info for the definition file author.