Commons:VicuñaUploader/Documentation
THIS PAGE IS IN PREPARATION
About
editVicuñaUploader (VU) is stand-alone software designed to upload files to Wikimedia Commons and other servers. You don't need to be online to prepare your file set for upload. The software allows you to fill in information about a file individually or for groups of files at once. If the computer is connected to the Internet, several helpful functions are available, such as finding existing category names or adding a template of the coordinates of the photographer's position and the direction of photography.
Document conventions
editThis is collaborative documentation, so everybody can contribute to it. Below is an explanation of the highlighting used in this text and how to work with it:
strike out text– means not valid at the moment, but it's expected to be valid again- R1-like links – points to specific section and number to the number of item. So R1 means item 1 in section Requirements
code text
– this type of text highlights code text, you have to type to the console or you get it from the console- text in italics – highlight of important text
- text in bold – higher level of highlighting the important text. Bold could be nested with italics to get bold-italics
- (-text-) – indicates the variable. The text describes the variable and you replace this string with your variable. For example (-number-) in jdk.java.net/(-number-) should be replaced by a number of the actual version as of the creation of this manual we don't know, what version will be on that website tomorrow. So in this case the right string would be jdk.java.net/20
- INCOMPLETE – points out the section, which is not complete
Requirements
edit- Operation system: Windows 10 and higher, Linux-like, MacOS
- Java: 11 to 16 (or OpenJDK 11 )
(if you cannot upgrade your Java on Windows use portable executables of VU)
Getting started
editCheck your Java, install or upgrade
editWindows
edit- Go to Search
- Type in
cmd
and press ENTER - Type in
java -version
and press ENTER - If you see R2 (e.g.
openjdk 20.0.1 2023-04-18
, which means you have OpenJDK 20) you are fine and you can proceed to Download and Installation – otherwise, follow these instructions (but you should have 64bit Windows version (to check typesysteminfo
and press ENTER to see inSystem Type:
)):- Go to OpenJDK website
- Click on jdk.java.net/(-number-) link
- Download the archive file for Windows
- Unzip the download file
- Move the directory to the directory of your choice
- Click on the OpenJDK folder to get to the bin folder
- Click on taskbar and copy the link to the bin folder (it could look
C:\Program Files\OpenJDK\jdk-21.0.1\bin
) - Go back to Command Prompt (cmd Window) and type in SystemPropertiesAdvanced
- Click on Environment Variables...
- Click on the PATH and then on Edit...
- Click on New paste the link, and click on OK
- Then click on New in Environment Variables...
- Add JAVA_HOME for Variable name:, and paste the link for Variable value:, but remove "bin" (so it should look like
C:\Program Files\OpenJDK\jdk-21.0.1\
) - Click on OK
- Close Command Prompt
- Run vicuna.bat in yourvicunafolder/bin
Linux
editDebian and derivatives (e.g. Ubuntu)
editINCOMPLETE
- Open terminal (usually CTRL ALT T)
- Type in
java -version
and press ENTER - If you see R1 (e.g.
openjdk 11.0.19 2023-04-18
, which means you have OpenJDK 11) you are fine, and you can proceed to Download and Installation – otherwise, follow these instructions:- Update information about packages by typing in
sudo apt update
- List available package versions by typing in
apt list "openjdk-*-jdk"
- Install the highest available version by typing in
sudo apt install openjdk-(-number-)-jdk
, where (-number-) is replaced by the highest number available (e.g.sudo apt install openjdk-19-jdk
)
- Update information about packages by typing in
MacOS
editIn order to be able to start the VicuñaUploader, a current version of Java must be installed on the Mac. The author suggests version 11 for this, we would recommend version 17.
- Visit the official Java download page for version 17
- Make sure both the 'JDK17' and 'macOS' tabs are selected
- Download the following file: ARM64 DMG Installer (If this file does not work, try the x64 version)
- Install Java by opening the downloaded .dmg file
- Download the current version of the as a .tar package
- Extract the .tar package and navigate to the vicuna/bin directory
- Start the `Vicuña` file by right-clicking on it and selecting “Open…” from the context menu
- The console and the VicuñaUploader should now open and the application should also appear in the menu bar below.
Download and install VicuñaUploader
editYou can download VU from this link. Click on the version code and under the Assets paragraph you can see different files to download. If you are downloading VU for the first time, use one of the *.tar or *.zip files. (If you were not able to download/update your Java to the required one on Windows, download the *portable.zip version.) Then extract (untar/unzip) it to the location from where you would like to run it.
There is no need to install VicuñaUploader. You just run it.
Startup
editGo to the directory, where you extracted tar/zip file. Find the bin directory and:
- double click on vicuna file if you are on Linux-like operating systems
- double click on vicuna.bat if you are on Windows operating system
- optionally if you were not able to upgrade Java, you can double click on vicuna-launcher.exe
Unistall
editAs there is no installation, there is no uninstallation. You just delete VU main directory.
Updates
editNotes
editAs per version 1.3.3a, VU doesn't support 2FA accounts.