X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=yarrg%2Fweb%2Fupload;h=6de28be2189230ad4909f98024bce366c599bccc;hp=f723c7c2e81fc646ea519fe725e70a68cb9ffb94;hb=3e4a7984047224b0ffc532bbfaec359b37a7bc63;hpb=eb4dd353926d8d5f38ea442ee172ce0b2bb5925e diff --git a/yarrg/web/upload b/yarrg/web/upload index f723c7c..6de28be 100755 --- a/yarrg/web/upload +++ b/yarrg/web/upload @@ -1,73 +1,211 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component generates information about the uploader. + + + <& docshead &> +<%shared> +my $url_base_base= 'http://yarrg.chiark.net/download/jarrg'; + +<%def downloadurl><%args> +$leaf +$test => 0 +# ^ change this to change the default version +<%perl> +my $download_version= $test ? '/test' : ''; +my $url_base= "$url_base_base$download_version"; +my $url= $url_base.'/'.$leaf; +<% + $m->has_content ? $m->content : $url +%>

Uploading to YARRG

The YARRG system has two main parts: this website which maintains a -searchable database of commodity prices, and an upload client, which -screenscrapes the commodity data from the Puzzle Pirates game client -and uploads it to the database. +searchable database of commodity prices, and an upload client (known +as JARRG), which screenscrapes the commodity data from the +Puzzle Pirates game client and uploads it to the database.

You will need to upload data yourself if there is no data for your ocean or island, or the data that is there is too old. You should -also upload when preparing trade run, as market conditions change and +also upload when preparing a trade run, as market conditions change and you want a plan based on recent data. -

Uploading from Linux

+

+ +The JARRG upload client uploads both to YARRG and +PCTB. It is intended to +replace both the "yarrg" and "PPAOCR" screenscrapers. -The YARRG upload client uploads both to YARRG and -PCTB. +

Instructions

+ +First you must install JARRG, following the instructions for +your operating system, below. This will not modify your Puzzle +Pirates installation. Instead, it provides you with a new way to run +Puzzle Pirates which integrates it with JARRG to provides a YARRG/PCTB +Upload facility.

-The current official version of YARRG for use as an upload -client can browsed here: - http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/ -See particularly the -YARRG README. +To upload data, run the Puzzle Pirates client with JARRG (as detailed +below). You should see both the Puzzle Pirates window and the JARRG +window appear. Log in normally, and visit a commodity trading screen +(at a market, shoppe or vessel hold). Select "All Commodities" in the +YPP client. Then press "Upload Market Data" in the JARRG window.

-To install the client, install the `git' version control system -and the other dependencies listed in the `Installation requirements' -section of the README and then run: -

-git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
-cd ypp-sc-tools
-cd yarrg
-make
-
-this will download the code into the directory ypp-sc-tools, -and build the software. (If your Linux is very up to date you may -find that it complains that it doesn't know the command git-core. -In that case, use git core, with a space, instead.) + +It is OK to switch away from the commodity list in Puzzle Pirates as +soon as the Jarrg progress bar appears. The uploader has taken a copy +of the data, so you can do something else while the upload takes +place.

-When new versions of the upload client are released, you can: +The JARRG integration is done via fully supported Java Accessibility +interfaces, and should not disturb the normal running of Puzzle +Pirates. However, please make sure that if your YPP client misbehaves +at all, you try starting it in the vanilla way (without JARRG +integration) before asking for help. In particular, if the JARRG +startup does not work, but the ordinary Puzzle Pirates startup does, +report the problem to us, not to Three Rings. + +

Installing and running on Linux

+ +Download +<& downloadurl, leaf => 'jarrg-linux.tar.gz' &> +and unpack it. You run jarrg from the command line. Change +(cd) to the top level jarrg directory +which was created when you unpacked the tarball, and then run 
-cd .../ypp-sc-tools
-git-pull
-cd yarrg
-make
+./jarrg /path/to/yohoho/yohoho
-to fetch the new version. (Again, you may need git pull -instead of git-pull.) +where /path/to/yohoho/yohoho is the location of the +ordinary Puzzle Pirates startup script, which is normally +yohoho/yohoho in your home directory. + +

Installing on Windows

+ +Download +<& downloadurl, leaf => 'jarrg-setup.exe' &> +and double-click on it. It will either: +
    +
  1. Just work, in which case you'll have a new icon on your desktop which + runs Puzzle Pirates with JARRG integrated. +
  2. Fail, and tell you what to do next. Usually this means installing a + Java Runtime Environment (or JVM) and then uninstalling and re- + installing Puzzle Pirates. (Don't worry about reinstalling; you + won't lose any of your pirates or pieces of eight!) +
+ +

Installing on Macs

-

Uploading from Windows

+We believe that it should be straightforward for a MacOS expert to get +JARRG working properly on MacOS but we have not been able to +test this ourselves. The Linux installation method is probably the +best starting point. -There is not currently an upload client for Windows which feeds data -into YARRG. It would probably be straightforward to modify the -Windows PCTB v5 upload client to upload to YARRG as well. +

How does it work? Is it a violation of the Terms of Service?

+ +Essentially, JARRG is a specialised "screen reader" which instead of +reading information out loud, uploads it to the YARRG and PCTB +databases. + +

+ +JARRG uses the Java Accessibility API, which is a part of the +Java platform. It's a facility in Java, available for all Java +programs, intended to help make applications available to users with +disabilities: for example, it permits hooking in screen readers. The +use of the Java Accessibility API was helpfully suggested by a Ringer +in the forums (to another developer of a third-party tool, wanting +help getting information out of Duty Reports). + +

+ +Installing JARRG does not modify any game files, and does not +hook into the game itself. It makes no permanent or global changes to +your overall computer, operating system or Java configuration. And it +does not access (indeed, we don't think it could access) any of the +core game functionality which would make cheating possible.

-See our Developers' information page. +JARRG runs the unmodified Puzzle Pirates game, but with a separate +copy of your system's JVM (Java Virtual Machine); that copy of the JVM +is configured to use the JARRG accessibility plugin. We do this +(rather than configuring the computer's main JVM to use the +accessibility plugin) to avoid interfering with other uses of Java on +your computer - in particular, so that it is always possible to launch +Puzzle Pirates without JARRG (for example, in case the plugin +should cause any kind of problem). + +

Authorship, source code and other versions

-

Uploading from Macs

+Thanks to Burninator for writing the core of the JARRG client. Ian +Jackson and Owen Dunn adapted it to improve the installation setup (in +particular, to avoid modifying any of the YPP client's startup files). +Owen Dunn added support for uploading to YARRG, updated the build +system, and wrote a Windows installer. + +

+ +JARRG is +Copyright 2006-2009 Burninator, +Copyright 2009-2010 Owen Dunn and +Copyright 2009-2010 Ian Jackson. +It is Free Software with NO WARRANTY, released under +the MIT-style two-clause licence. + +

+ +The code for the downloadable binaries is in +in <& downloadurl, leaf=>'jarrg-source.tar.gz' &>. +The download directory also sometimes contains other versions +(eg unreleased test versions), which you can see here: + <& downloadurl, leaf => '', test => 0 &> + +

+ +We maintain JARRG in git, and you can get +source code for recent and perhaps unreleased versions from one of: +

+git://git.yarrg.chiark.net/jarrg-ian.git (gitweb)
+git://git.yarrg.chiark.net/jarrg-owen.git (gitweb)
+
-There is not currently a publicly available upload client for Macs for -either YARRG or PCTB. <& footer &>