The Wine port manager for OS X.

Play your favourite windows games on Mac

Barrel User Manual version 1.0

So, you've downloaded Barrel, and installed it, but how do you use it? Barrel is designed to be user friendly and very easy to use, although it's making use of Wine, which is notoriously difficult to play around with.

The Barrel user interface is split into 3 main regions:


Barrel UI


  1. The sidebar:
    The sidebar is where you organise your games. Each game needs to belong to a "Genre". The genres are under the "Library" option on the left side of the window. Under that, there is the "Collections" list, where you can create and customise your own lists. You can then drag and drop your games in your lists to organise them as you like. You can edit, or delete a list you created by right-clicking on it.
  2. The Library:
    This is where your games are listed. The games that you see are the ones that belong to the Genre, or Collection you selected in the sidebar. There's a special Collection in the sidebar, which is called "All Games". This will show you all the games in your library, regardless of the Genre or the Collection they belong to.
    You can select a game by left-clicking on it with your mouse. Its selection ring will change to a blue colour. Double-clicking, or pressing space on your keyboard will launch the game, and finally right clicking will show the Context menu. From the context menu you can do all kinds of things, which are explained further below.
  3. The Toolbar:
    The bottom horizontal bar of the application is called the "Toolbar". From the toolbar, you have five different options:
    • Plus Button: Click on this to add a new collection in the sidebar.
    • Arrow Button: Clicking this will hide the sidebar. Click on it again to show it again.
    • The view options: There are three options here, the Grid view, the Cover flow view and the table view. Choose the view that you like. Each genre or collection can have its own view style.
    • The Search form: Type the name of the game you're looking for here, and Barrel will search for it in your current view. Please note that this is not a global search, unless you've selected the "All games" collection.
    • The grid size slider: This will resize the grid items in the Grid view. This option is only available in the Grid view.

Importing a new Game

Empty Library


This is what you'll see the first time you run Barrel. This is an empty Library view. To start your import, you need to have your game ready. There are three main states your game can be in: it's either in a CD or DVD disc, in a disc image (.iso, .dmg or other types) or it is a stand alone installer (.exe). Barrel supports all these types! Depending on where your game is, you need to:

Your next step is to drag and drop the icon from your desktop on the big arrow in Barrel. If you have an .exe file you can do the same thing, drag and drop the .exe file instead.

Barrel will start processing your request. It will first try to connect to the remote server that feeds Barrel with info about all kinds of games, so it knows how to process the game you're trying to install. It will then instruct Barrel on how to continue. It does that by sending Barrel a file called a "recipe", which is nothing more than a .plist file.


Automatic Installation


Automatic Installation

If everything goes well and Barrel manages to find a recipe, it will automatically continue with everything and won't bother you again until it's time to install the game! Once everything is prepared, the game's installation wizard should run. Just follow the installer as you would on Windows. Once the installation is done, you will be asked for the game's executable file. Barrel will show you all new .exe files that were added by the installer. You just have to pick the right one! Worry not, as this is something that's easy to detect with your eyes. The file you are looking for is usually named after the game, so it will probably be "yourGameName.exe" inside the folder "Program Files". It could also be an abbreviation of the game's name. Age of Empires, for example, has a main binary file called "aoe.exe".

Once you've done this, Barrel will take over again, installing all requirements and finalising the bundle's configuration. When the configuration is finished, it will add your game in your library, along with the artwork that is stored on the server! You can, of course, change that if you prefer another image. For instructions on how to do this, check the "Context Menu" section below.


Manual Installation


Manual Installation

There are cases where Barrel won't be able to match your game to a server entry. This can happen if you are using a non-standard release of the game, or if the game is not yet supported (or has not yet been shared by a porter). IF you use a non-standard release, you can try to do a manual lookup, by clicking the "Manual Search" button and entering the name of the game you're trying to import. If a result is found, the automatic installation will continue, if not you can try to port the game yourself.

The rule of the thumb, is that most DirectX 9 games for windows should be easily portable, without the need to override and install 3rd party libraries. There are some cases, though, where 3rd party libraries are mandatory for a game to successfully run in Barrel.

If you are the first to try and install a given game, Barrel won't be able to find a match on the server and will ask you for a few details, in order to try and install a game for you. You will need to provide a name for the game, and choose one of the available Barrel Wine engines. Generally, the latest, the better, but there are some cases where games will run better with older engines.

After you select an engine, the automatic installation described above takes charge, and you can follow the installation wizard as you would for a normal installation. The only difference, is that when the installation is done, no automatic bundle configuration will take place, and there is a great possibility that the game won't run with Barrel. You will be taken to the game Library, where you'll see a new entry, with no artwork. You should then do a "Debug run" (see "Context Menu" section) to check if the game runs. If it doesn't, and all you get is the view log window, it means that the game may either need further configuration to run, or that it is not supported by Wine, and in extension - Barrel.

A good place to check a game's compatibility with Wine is The Wine Application Database, until Barrel's own game compatibility database is ready for release. You can also find configuration instructions there, which should normally apply to Barrel as well. You can install the required libraries by using Barrel's Winetricks manager, described further below in this document.


The Context Menu

The context menu is where you can manage your game bundle, and where you can port your games before you share them with other people. Right-clicking on an item in the Library view, will give you all the options that you are looking for. The options that are available are shown below in the hierarchy that they appear in the current version (0.9 Beta 4):

  1. Start Game - Clicking on this will launch the game
  2. Show in Finder - Opens a Finder window with the location of the Bundle (more with what you can do with that is further down in this manual)
  3. Advanced Settings - Holds all the advanced options for Wine. No action when clicking this option
    • Debug Run - First you are asked the debug options for wine, and then it starts the game. All Wine output is logged in the file "Wine.log" located inside the Bundle's "Contents/Resources" path. Once the game quits (or crashes) you will be given the option to open the log file in TextEdit.
    • Wine Config - Launches Wine's Config application
    • Registry Editor - Launches Wine's Registry Editor
    • Winetricks - Launches Barrel's Winetricks manager. More info follows further down in this document
    • Run external .exe - Allows you to execute a windows binary (.exe) that resides outside the Barrel bundle. This is helpful when you need to update your game, for example.
    • Change executable path - This allows you to change the .exe file that is launched by default. You can only choose a .exe which resides inside the bundle's "drive_c" folder (it's in Game.app/Contents/Resources/drive_c)
  4. Rating - This option lets you rate your game locally. It will soon be replaced with a global rating system, though!
  5. Add Cover Art from File - This option lets you choose the cover art (image) that is displayed for your item in your library. You need to select a local file for this. Any image size will do, but we suggest selecting a portrait image bigger that 500px high
  6. Add to Collection - Presents options to add a game to a collection
    • New Collection from Selection - This option will create a new Collection in the sidebar, and will add the games you have selected into it.
    • Selection Name - The rest of the options are the Collections that you already have. Clicking on one will add the selected item(s) in the selected Collection
  7. Rename Game - This option lets you rename your game.
  8. Delete Game - This option allows you to delete your game. You will be asked to confirm your deletion, as long as you haven't clicked the "Don't ask me again" option in the popup. You will also be asked if you want to delete just the reference to the file, or both the reference and the file. Deleting both will remove the game from your library and move the bundle to your Trash. Please note that you cannot currently restore a game from your trash, but we're working on it!

Winetricks


Barrel Winetricks Manager

Barrel offers a very easy-to-use manager window where you can browse and install winetricks packages for your port. The UI is very straightforward, you just have to select the packages that you want to install from the list view, and then click "Execute Winetricks". Barrel will show you the final wintricks command that will be executed, and will then start the winetricks installer. You can view winetricks' output in the bottom half of the winetricks manager. If you get any popup windows during winetricks installation, just follow the instructions on them to complete the installation.
Barrel will regularly check for any updates to the winetricks installer, individually for your bundles, before you open the winetricks manager. If any updates are found, it will automatically download the new winetricks installer binary, parse it and present the options to you.

This concludes the user manual. If you experience any bugs in the application, please don't forget to report them in the project's GitHub Issues page. Please, also check the FAQ sections for further possible answers to your questions.