diff --git a/docs/linux-guide.md b/docs/linux-guide.md new file mode 100644 index 00000000..1c4cc417 --- /dev/null +++ b/docs/linux-guide.md @@ -0,0 +1,43 @@ +# 🐧 Linux Guide + +Welcome Linux users! Unfortunately Cycling '74 doesn't provide a Linux version of Max8. However, we can get it to run decently we enough with [Wine](https://www.winehq.org/). + +# 🍷 Installing and Setting Up Wine + +Follow the instructions to [install Wine](https://wiki.winehq.org/Download) for your distro. Make sure you install 7.0 or newer. + +Next follow the instructions to [install winetricks](https://github.com/Winetricks/winetricks#installing) (this part may be optional, but helpful) + +Run the following commands to set up and configure Wine: + +``` +wineboot -u +winetricks corefonts vcrun2010 vcrun2013 vcrun2015 +``` + +Finally run `winecfg` and set the Windows version to Windows 8.1 (because NodeJS requires >=8.1). + + +# 💻 Install Mercury with Wine + +1. Download Max8 through any of the links below. +- [Windows](https://akiaj5esl75o5wbdcv2a-maxmspjitter.s3.amazonaws.com/Max808_x64_190808.zip) +- If links are not working you can go to [https://cycling74.com/downloads/older](https://cycling74.com/downloads/older) and select the Windows version + +2. Extract and run the MSI installer with `wine msiexec /i /path/to/Max808_x64_190808.msi` + +3. Launch Max with `wine ~/.wine/drive_c/Program\ Files/Cycling\ \'74/Max\ 8/Max.exe` + +4. Follow the rest of the instructions in the [Quick Start guide](./quick-start.md) to set up Mercury with Max. +Be patient when launching Mercury, the windows may become unresponsive, but they just need some time to load. + + +# 🙁 Limitations + +There are some known issues with running Mercury on Linux: + +1. Alt+Enter does not run the code when using the Visual Editor. You will either need use File > Execute Code, use File > Load External Editor File, or use a tool like [Flok](./collaborate.md). + +2. Performance can be poor, try adjusting some of the settings described in the [troubleshooting guide](./08-troubleshooting.md) + +If you hit any issues not covered in this guide, see if it's covered in [this Max forum thread](https://cycling74.com/forums/max-on-linux/replies/3). diff --git a/docs/quick-start.md b/docs/quick-start.md index f2b57edb..569fcde1 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -13,6 +13,7 @@ Mercury runs in Max8 (sometimes also called MaxMSP), a node-based creative codin - [Windows](https://akiaj5esl75o5wbdcv2a-maxmspjitter.s3.amazonaws.com/Max808_x64_190808.zip) - [Mac](https://akiaj5esl75o5wbdcv2a-maxmspjitter.s3.amazonaws.com/Max808_190808.dmg) - If links are not working you can go to [https://cycling74.com/downloads/older](https://cycling74.com/downloads/older) +- Linux users can try out the [experimental Linux guide](./linux-guide.md) 2. Launch Max8 after installing. It will create a `Max 8` folder in your `Documents`. In there you may create a folder named `Projects`. The full path should now look like this: `/Documents/Max 8/Projects` diff --git a/docs/tutorial.md b/docs/tutorial.md index 983bee38..718aeba9 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -41,6 +41,7 @@ Mercury runs in Max8 (sometimes also called MaxMSP), a node-based creative codin - [Windows](https://akiaj5esl75o5wbdcv2a-maxmspjitter.s3.amazonaws.com/Max831_220510.zip) - [Mac](https://akiaj5esl75o5wbdcv2a-maxmspjitter.s3.amazonaws.com/Max831_220510.dmg) +- Linux users can try out the [experimental Linux guide](./linux-guide.md) - If links are not working you can go to [https://cycling74.com/downloads/older](https://cycling74.com/downloads/older) 2. Once you installed Max8 you can launch it. It will create a `Max 8` folder in your `Documents`. In there you may create a folder named `Projects`. The full path should now look like this: `/Documents/Max 8/Projects`